Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DerivedEntity

The Derive entity object

Enumerations

Properties

Methods

Properties

Optional derivedProperties

derivedProperties: undefined | object

Property-bag (key-value pairs where key is Shape Field resource name and value is object)

Optional identifier

identifier: undefined | string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional key

key: undefined | string

The object key.

Optional metadata

metadata: model.ObjectMetadata

Optional mode

mode: Mode

Determines whether entity is treated as source or target

Const modelType

modelType: string = "DERIVED_ENTITY"

Optional modelVersion

modelVersion: undefined | string

The object's model version.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow reference across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectVersion

objectVersion: undefined | number

The version of the object that is used to track changes in the object instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional refDataObject

refDataObject: ReferencedDataObjectFromAPI | ReferencedDataObjectFromProcedure

Optional resourceName

resourceName: undefined | string

The resource name.

Optional shape

shape: model.Shape

Optional shapeId

shapeId: undefined | string

The shape ID.

Methods

getDeserializedJsonObj

getJsonObj