Retrieve a break definition

Introduction

You can retrieve a break definition by the internal ID or an external reference using the GET call. Internal IDs for break definitions can be found by listing all break definitions using the GET collection endpoint.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/break-definitions/{breakDefinitionReference}

URL parameters

This parameter needs to be filled in when calling this endpoint.

Parameter	Description
<breakDefinitionReference>	The internal ID or external reference of the break definition.

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.

External references

It’s possible to use custom external references. More information can be found on the External References Page

Examples

Retrieving a break definition by internal ID

Example with internal ID 7:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/break-definitions/7

With custom external reference

Example with custom external reference MORNING-BREAK:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/break-definitions/MORNING-BREAK?externalReferences=(break-definitions,customBreakCode)