v1

latestOpenAPI 3.0.12026-07-1431191129.7 KB
VersionHistory

Get the history for a record or relationship

Retrieves a list of all operations performed on a specific source entity (record or relationship). Results can be paginated and filtered by a date range.

get/sources/{sourceKey}/v1/history/{collectionType}/{collectionKey}/{itemId}/operations

Path parameters

sourceKeystring required

The source key.

collectionType'resources' | 'relationships' | 'objects' required

The type of the collection.

collectionKeystring required

The key of the collection.

itemIdstring required

The id of the item.

Query parameters

perPageinteger

The number of items to return per page.

pageinteger

The page number to retrieve.

fromstring date-time

The start of the date range filter (ISO 8601 format). The default value is the beginning of time.

tostring date-time

The end of the date range filter (ISO 8601 format). The default value is now.

Response

A list of version history items for the entity.

idstring required

The unique identifier of the resource or relationship.

typestring required

The collection type of the entity.

targetType'resources' | 'relationships' | 'objects' required
operationIdstring required

The unique identifier of the operation.

taskIdstring required

The identifier of the task that processed this operation.

timestampstring date-time required

The exact time the operation was applied.

action'CREATE' | 'UPSERT' | 'DELETE' | 'UPDATE' required

The action to perform.