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/breaks?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 break record. |
person.id |
integer | Internal ID of the person this break belongs to. |
breakDefinition.id |
integer | Internal ID of the linked break definition. |
date |
string | Date for which the break is recorded (YYYY-MM-DD). |
calculatedDurationInMinutes |
integer | Calculated duration of the break in minutes. |
clockedDurationInMinutes |
integer | Actual clocked duration of the break in minutes. |
startTimeInMinutes |
integer | Earliest start time from the break definition (minutes since midnight). |
endTimeInMinutes |
integer | Latest end time from the break definition (minutes since midnight). |
isBreakTaken |
boolean | Indicates whether the break was taken. |
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
Delta with date filter
Example with a start date:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/breaks?delta&filter=date ge '2024-01-01'
Delta with date range filter
Example with a date range:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/breaks?delta&filter=date ge '2024-01-01' and date le '2024-12-31'