The version object
A comprehensive list of the version resource's attributes and relationships
A version object is returned as part of the response body of each successful list or retrieve API call to the /api/versions
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The version unique identifier |
links.self |
| The version endpoint URL |
attributes.changes |
| The object changes payload. |
attributes.created_at |
| Time at which the resource was created. |
attributes.event |
| The event which generates the version. |
attributes.ip_address |
| The request remote ip. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.resource_id |
| The versioned resource id. |
attributes.resource_type |
| The type of the versioned resource. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.user_agent |
| The request User Agent. |
attributes.uuid |
| The request id. |
attributes.who |
| Information about who triggered the change. |
meta.mode |
| The resource environment (can be one of |
Last updated