Versions Compared

Old Version 1

changes.mady.by.user Nick Jensen

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

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

The offset in search results from where return data If omitted, offset is set to zero
Required fields

 fromDateUTC date to compare entity modification dates to.
Optional fields
 offset to.
 limitThe maximum number of entities to return. It is not possible to return more than 50 entities per request, and if omitted, limit is set to 50
Code Block
{
   "fromDate": "2015-01-01T01:00:00Z"
}


Code Block
{
   "fromDate": "2015-01-01T01:00:00Z",
   "offset": 0,
   "limit":
5
}



Span
stylewhite-space:pre
Response body:


JSON data with an array of the found entities. The result will also contain an object with properties that specify number of entities returned, the offset and whether there are more entities than the ones returned. containing the session token.

Code Block
{
   "entitiestoken": [ 12345, 12346, 12347, 12348, 12349 ],
   "paging": {
      "offset": 0,
      "count": 5,
      "more": true
   }
}"m2x31pn1bu"
}


Status codes:200

One or more entities were found

 404No updated entities were found202

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