<access-service>/api/v1/items/delta

URL structure

https://access-service.xy-company.com/api/v1/items/delta

Supported methods and overview

• GET - used to retrieve lists of changes to the currently authenticated Covata user's^* Secure Objects and collections (i.e. items).

Detailed description

This API endpoint retrieves lists of changes to the currently authenticated Covata user's^* Secure Objects and collections from a given point in time, which includes separate lists for:

• New items (added),
• Deleted items (removed) and
• Modified items.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator's Guide):

• Originator
• Collaborator

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Optional parameters

The following optional parameters can be sent in the URL of the GET request:

• cursor - The cursor value returned from the previous request to this API endpoint. The default value is 0.

• pageSize - 1 to 100 (default is 10).

  Example ():

Returns

A JSON-formatted response containing the following members:

• added - .
• removed - .
• modified - .

• cursor - An ID value representing the current point in time from which a subsequent call to this API endpoint can generate new (i.e. subsequent) lists of changes to the currently authenticated Covata user's items.

  Example (response from ...):

^* The currently authenticated user is determined by the access token passed in the header of requests to this endpoint.