Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PublishedObjectSummary

The published obect summary.

Properties

Functions

Properties

Optional description

description: undefined | string

Detailed description for the 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

Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create.

Optional metadata

metadata: model.ObjectMetadata

modelType

modelType: string

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 parentRef

parentRef: model.ParentReference

Functions

getDeserializedJsonObj

getJsonObj