EntityMetadata

EntityMetadata

Metadata about an entity. id, modelKey and creationDate are invariant against the point-in-time. All other values are with respect to the as-at point-in-time for which the entity was retrieved. If the point-in-time was not explicitly set, the values correspond to the latest state of the entity.

Schema Viewer

EntityMetadata

Metadata about an entity. id, modelKey and creationDate are invariant against the point-in-time. All other values are with respect to the as-at point-in-time for which the entity was retrieved. If the point-in-time was not explicitly set, the values correspond to the latest state of the entity.

idstringrequired

ID of the entity.

modelKeyModelSpec

Model of the entity.

statestringrequired

The state of the entity at the given point-in-time.

creationDatestringrequired

The creation date of the entity.

lastUpdateTimestringrequired

The last time the entity was updated as-at the given point-in-time. 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 as-at the given point-in-time.

transactionIdstring

The transaction id of the entity when last saved as-at the given point-in-time.

Description

Metadata about an entity. id, modelKey and creationDate are invariant against the point-in-time. All other values are with respect to the as-at point-in-time for which the entity was retrieved. If the point-in-time was not explicitly set, the values correspond to the latest state of the entity.

Properties

• id (string, required): ID of the entity.
• modelKey (object): Model of the entity.
• state (string, required): The state of the entity at the given point-in-time.
• creationDate (string, required): The creation date of the entity.
• lastUpdateTime (string, required): The last time the entity was updated as-at the given point-in-time. 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 as-at the given point-in-time.
• transactionId (string): The transaction id of the entity when last saved as-at the given point-in-time.

Related Schemas

See other schemas in the common category.