Skip to content
Settings

EntityMetadata

Schema definition for EntityMetadata

EntityMetadata

idstringrequired
ID of the entity.
modelKeyModelSpec
Model of the entity.
statestringrequired
The state of the entity.
creationDatestringrequired
The creation date of the entity.
lastUpdateTimestringrequired
The last time the entity was updated. Equals the creation date if the entity has not been updated.
pointInTimestring
Optional value for the as-at point-in-time for which the entity was retrieved.
transitionForLatestSavestring
The transition applied of the entity when last saved.

This schema defines the structure and validation rules for EntityMetadata.

  • id (string, required): ID of the entity.
  • modelKey (object): Model of the entity.
  • state (string, required): The state of the entity.
  • creationDate (string, required): The creation date of the entity.
  • lastUpdateTime (string, required): The last time the entity was updated. Equals the creation date if the entity has not been updated.
  • pointInTime (string): Optional value for the as-at point-in-time for which the entity was retrieved.
  • transitionForLatestSave (string): The transition applied of the entity when last saved.

See other schemas in the common category.