Retrieve a list
Introduction
You can retrieve a list of break definitions.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/break-definitions
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 | Internal unique identifier for the break definition. |
name.default |
string | Default name value of the break definition. |
name.translations |
object | A list of translated names of the definition by language code. |
friendlyName.default |
string | Default friendly name value for this definition shown to users. |
friendlyName.translations |
object | A list of translated friendly names by language code. |
paidDurationInMinutes |
integer | The paid duration of the break in minutes. |
minimumDurationInMinutes |
integer | The minimum duration required for the break in minutes. |
maximumDurationInMinutes |
integer | The maximum duration allowed for the break in minutes. |
ifNotClockedDurationInMinutes |
integer | The time that is calculated if no break is taken. In most cases this will be the same as the minimumDurationInMinutes. |
hasToBeTakenUninterrupted |
boolean | Indicates if the break must be taken without interruption. |
Filters
This endpoint does not require any filter parameters. It returns all break definitions in the system.
External references
It’s possible to use custom external references. More information can be found on the External References Page
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Examples
Retrieving all break definitions
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/break-definitions