Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

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.

Note

This endpoint cannot be used when Data Isolation is enabled


Endpoint ID:1012
Method:
Status
colourGreen
titlePOST
URL:

/userentity/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.


Code Block
{
   "fromDate": "2015-01-01T01:00:00Z"
}



Span
stylewhite-space:pre
Response body:


JSON data containing the session token.

Code Block
{
   "token": "m2x31pn1bu"
}


Status codes:200One or more entities were found202

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