Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Schema

The schema object.

Properties

Optional defaultConnection

defaultConnection: undefined | string

The default connection key.

Optional description

description: undefined | string

User-defined description for the schema.

Optional externalKey

externalKey: undefined | string

The external key 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 isHasContainers

isHasContainers: undefined | false | true

Specifies whether the schema has containers.

Optional key

key: undefined | string

The object key.

Optional metadata

metadata: model.ObjectMetadata

Optional modelType

modelType: undefined | string

The object's type.

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

Optional resourceName

resourceName: undefined | string

A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Schema): object

getJsonObj

  • getJsonObj(obj: Schema): object