1012: Create changed since session

Owned by Nick Jensen
Last updated: May 23, 2022


Begin a search session to find all Rubiq entities that have been modified since a given date, and return the session token identifier.The token can then be sent to endpoint 1013: Get changed since to begin paging through the search results.

Note that the search session is generated asynchronously, so requests to endpoint 1013 may not return results immediately.

This endpoint cannot be used when Data Isolation is enabled

Endpoint ID:1012
Method:POST
URL:

/entity/changes/{contract-id}


contract-id

Identifies the type of entities to search for. If omitted, the default contract entity type is returned.

Request body:

JSON data with search settings

Required fields

fromDateUTC date to compare entity modification dates to.
{
   "fromDate": "2015-01-01T01:00:00Z"
}


Response body:

JSON data containing the session token.

{
   "token": "m2x31pn1bu"
}
Status codes:202

A search session was created, and an asynchronous task to populate the search results has begun