• Public
  • Public/Protected
  • All

Namespace CreateEntityShapeFromFile

The file data entity details.


Optional dataFormat

dataFormat: model.DataFormat

Optional description

description: undefined | string

Detailed description for the object.

Optional entityType

entityType: EntityType

The entity type.

Optional externalKey

externalKey: undefined | string

The external key for the object.

Optional foreignKeys

foreignKeys: Array<ForeignKey>

An array of foreign keys.

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.

Const modelType

modelType: string = "FILE_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 references 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 otherTypeLabel

otherTypeLabel: undefined | string

Specifies other type label.

Optional parentRef

parentRef: model.ParentReference

Optional resourceName

resourceName: undefined | string

The resource name.

Optional shape

shape: model.Shape

Optional shapeId

shapeId: undefined | string

The shape ID.

Optional types

types: model.TypeLibrary

Optional uniqueKeys

uniqueKeys: Array<UniqueKey>

An array of unique keys.