Breaks REST Endpoints

Sort by

Task Path Method

Availability Patterns/Shifts/Breaks

The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.

Create a break

Method: post

Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks

Delete a break

Method: delete

Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks/{breaksUniqID}

Get a break

Method: get

Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks/{breaksUniqID}

Get all breaks

Method: get

Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks

Update a break

Method: patch

Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks/{breaksUniqID}