Page Comparison

Excerpt
Return

...

entities for a search session specified by a token identifier.

The search session is started initialized by calling endpoint 1012: Create changed since session, which returns a token identifier.

...

The session is created asynchronously, so may not immediately be ready to access. When this endpoint is called for an incomplete session, a 204 response 202 response is returned instead of the 200 response which indicates a successful fetch. In this situation it is recommended to wait a few seconds, and try again.

The search session has an expiry of 1 hour. Any request to this endpoint for the session will refresh the expiry, but after an hour of inactivity the session may be deleted.

Note
This endpoint cannot be used when Data Isolation is enabled

Endpoint ID: 1013

Method:

Status

colour	Green
title	POST

URL:

/userentity/changes/token/{token}

token The session token to fetch data for

Request body:

JSON data with search settings

Optional fields
		offset	The offset in search results from where to return data. If omitted, offset is set to zero
	limit	The maximum number of entities to return. It is not possible to return more than 500 entities per request, and if omitted, limit is set to 500

Code Block
{}

Code Block
{ "offset": 0, "limit": 3 }

Span

style	white-space:pre

Response body:

JSON data with an array of

dp-keys

ids for the changed 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.

Code Block
{ "entities": [ { "

dpKey

id": 12345,
         "updatedDate": "2015-06-03T12:55:02"
      },
      {
         "

dpKey

id": 12346,
         "updatedDate": "2015-06-03T13:10:47"
      },
      {
         "

dpKey

id": 12347,
         "updatedDate": "2015-06-04T01:02:55"
      }
   ],
   "paging": {
      "offset": 0,
      "count": 3,
      "more": true
   }
}

Status codes:

200

One or more entities were found

204202 The search session is not yet complete - please wait a few seconds and try again

404

The search session contains no entities, or contains no entities for the given offset

Additionally the following sub code may be returned:

404.4 The session token was not recognized

...

Versions Compared

Old Version 2

New Version Current

Key