Retrieve a work interruption
Returns a single work interruptions record by its internal ID.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions/{id}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-work-interruptions.read
URL parameters
| Parameter | Description |
|---|---|
<id> |
The internal ID of the work interruption. |
Response properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
changeVersion |
string | — | Read-only | Property to indicate the order of changes. |
id |
integer | — | Read-only | Unique identifier for the work interruption record. |
person.id |
integer | — | Read-only | Internal ID of the person this work interruption belongs to. |
date |
string | — | Read-only | Date for which the work interruption is recorded (YYYY-MM-DD). |
durationInMinutes |
integer | — | Read-only | Duration of the work interruption in minutes. |
startTimeInMinutes |
integer | — | Read-only | Start time of the work interruption (minutes since midnight). |
endTimeInMinutes |
integer | — | Read-only | End time of the work interruption (minutes since midnight). |
External references
The endpoint supports predefined and custom external references. See the external references page for details.
The following collections are supported for this endpoint:
| Collection | Predefined | Custom |
|---|---|---|
people |
@badge-number, @employee-number |
Supported |
Caution
There are some restrictions on the characters allowed in URL requests. See the fetching resources page for more information.
Error responses
| Status | Condition |
|---|---|
401 |
Missing or invalid access token, or insufficient scope |
404 |
Work interruption with the given ID does not exist |
Examples
Retrieving a work interruption by internal ID
Example with internal ID 12345:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions/12345
With external reference for people
Example with internal ID 12345 and the employee number as an external reference:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions/12345?externalReferences=(people,@employee-number)