Retrieve a list
Introduction
You can retrieve a list of work interruptions using a filter.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions
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 |
|---|---|---|
person |
Optional | Filter by specific person IDs |
date |
Required | Date range (required with max of 1 year range) |
Check the Fetching Resources page on how to use the filter.
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 date range
Example with a date range:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions?filter=date ge '2024-01-01' and date le '2024-01-05'
Filter on people and a date range with external reference
Example with people, a date range and the employee number as an external reference:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions?filter= person in (115,256,385) and date ge '2024-01-01' and date le '2024-01-05' &externalReferences=(people,@employee-number)