Links

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
string
versions
id
string
The version unique identifier
links.self
string
The version endpoint URL
attributes.resource_type
string
The type of the versioned resource
attributes.resource_id
string
The versioned resource id
attributes.event
string
The event which generates the version
attributes.ip_address
string
The request remote ip
attributes.user_agent
string
The request User Agent
attributes.uuid
string
The request id
attributes.changes
object
The object changes payload
attributes.who
object
Information about who triggered the change.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
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
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
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.
meta.mode
string
The resource environment (can be one of test or live)