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
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-durations?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 | Unique identifier for the activity duration. |
person.id |
integer | Unique identifier of the person linked to this duration. |
date |
string | Date of the activity duration (YYYY-MM-DD). |
durationInMinutes |
integer | Duration in minutes for the activity. |
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. |
absenceDefinition.id |
integer | Unique identifier for the absence definition, if an absence is linked to the duration. |
request.id |
string | Unique identifier for the request, if the duration was requested. |
counterDefinitions.id |
integer | A list of unique identifiers for the counter definitions or multiple definitions, if one or more counters are linked to this duration. |
shiftDefinition.id |
integer | Unique identifier for the shift definition, if a shift is linked to the duration. |
status |
string | Status of the activity duration (Unknown, Auto, Manual). |
isAuthorized |
boolean | Indicates if the activity duration is authorized. |
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
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Good to know
Shift definition behaviour
The shiftDefinition property is typically linked to the activity duration, unless the shift is inherited from the schedule.
Tip
In cases where the shift comes from the schedule, the shiftDefinition is not included in the response. If the shift isn’t inherited from the schedule, the shiftDefinition will be included in the response.
Examples
A delta with date and external references
Example for activity durations with a delta starting from 1st of January 2025 and multiple external references:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-durations?filter=date ge '2025-01-01'&externalReferences=(people,@employee-number)(activity-definitions,@data-entry-code)(absence-definitions,@absence-code)(counter-definitions,@counter-code)&delta