Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ObjectRelationship

Details regarding a specific object and its relationship to the referencing object.

Properties

Optional key

key: undefined | string

Unique id of the object.

Optional name

name: undefined | string

Name of the object.

Optional parentKey

parentKey: undefined | string

Key of the parent object for the resource.

Optional parentPath

parentPath: undefined | string

Full path of the parent object.

Optional path

path: undefined | string

Full path of the object.

Optional relationshipType

relationshipType: undefined | string

Type of relationship with the referencing object.

Optional timeCreated

timeCreated: Date

The date and time the relationship was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The last time a change was made to this reference. An RFC3339 formatted datetime string.

Optional typeKey

typeKey: undefined | string

Type key of the object. Type keys can be found via the '/types' endpoint.

Optional typeName

typeName: undefined | string

Type name of the object. Type names can be found via the '/types' endpoint.

Functions

getDeserializedJsonObj

getJsonObj