Retrieve a delta
Introduction
It’s possible to retrieve changes with the delta.
Caution
Read the Delta page. There is important information on required implementation!
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/assignments?delta
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Internal unique identifier for the assignment. |
person.id |
integer | Internal ID of the person who the assignment is for. |
from |
string | Start date of the assignment (YYYY-MM-DD). |
until |
string | End date of the assignment (YYYY-MM-DD). |
startTimeInMinutes |
integer | Start time in minutes since midnight. |
endTimeInMinutes |
integer | End time in minutes since midnight. |
breakDurationInMinutes |
integer | Duration of the break in minutes. |
comments |
string | Comments associated with the assignment. |
activityLevels.level |
integer | A list of levels in the activity structure of the registered activity definition. |
activityLevels.activityDefinition.id |
string | Unique identifier for the activity definition registered. |
Filters
This list of filters can be used for this endpoint. Some filters are mandatory.
| Filter | Type | Description |
|---|---|---|
date |
Required | The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year |
Note
- People cannot be used in the delta
- The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year
- The end date isn’t required, when providing an end date there is a max range of 1 year
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page.
The following collections are supported for this endpoint:
| Collection | Predefined | Custom |
|---|---|---|
people |
@badge-number, @employee-number |
Supported |
activity-definitions |
@data-entry-code, @external-reference |
Supported |
Examples
Retrieving delta changes for assignments
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/assignments?delta