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/work-interruptions?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 work interruption record. |
person.id |
integer | Internal ID of the person this work interruption belongs to. |
date |
string | Date for which the work interruption is recorded (YYYY-MM-DD). |
durationInMinutes |
integer | Duration of the work interruption in minutes. |
startTimeInMinutes |
integer | Start time of the work interruption (minutes since midnight). |
endTimeInMinutes |
integer | End time of the work interruption (minutes since midnight). |
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.
Examples
Filter on a start date
Example with a start date:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions?delta&filter=date ge '2024-01-01'
Filter on date range with external reference
Example with a date range and the employee number as an external reference:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions?delta&filter=date ge '2024-01-01' and date le '2024-01-05' &externalReferences=(people,@employee-number)