Manage Availability Patterns
You may be using a third-party application that allows your employees to create and manage availability patterns for themselves or for their reports. You may want to ensure that these availability patterns are replicated on Oracle HCM Cloud to ensure availability calculations in Oracle HCM Cloud read the availability patterns defined for the respective employees. You can use the availabilityPatterns REST service to create, update, delete or retrieve availability patterns, the shifts which are part of the pattern, and the breaks that can be taken in each shift.
This use case discusses the following scenarios:
- Add an availability pattern
- Edit an existing availability
- Add a shift to an existing availability pattern
- Edit an existing shift on an availability pattern
- Delete an existing shift on an availability pattern
- Add a break to an existing shift
- Edit an existing break to an existing shift
- Delete an existing break from an existing shift
- Retrieving an employee's availability pattern
- Retrieving all availability patterns
A typical application flow for these scenarios is as follows:
- You configure availability types that will be used by the employee based in each country. Ensure Role Access for each availability type is configured in a way that ensures you always have at least one role that is granted "View and Edit" access to patterns belonging to each type.
- Identify the employee and the availability type that will be defined. Identify the shift pattern that will be used and the validity dates.
- When the user wants to create, update, delete or retrieve a pattern in the third-party application, the application makes a call to Oracle HCM availabilityPatterns REST service.
Let's take the following example to illustrate how this REST service works.
Gretchen hired Jen as a customer service associate in a retail store. She has negotiated with Jen that Jen will work at least 20 hours a week, and follow a specific shift pattern every week. Jen is allowed to declare her availability for overtime beyond the contractual hours, and this information will be used by the scheduling tool.
The contractual hours (called core hours) and her declared availability for overtime (called overtime) are availability types that are already set up in the system. The company allows either 15-minute breaks that can be taken any time during the shift (called short break) and a 30-min break that can be taken anytime within a specified range (called long break), as specified on the core hours availability pattern. Both these breaks are unpaid.
In the following scenarios, we will see how Gretchen sets up Jen's availability pattern, and how Jen can declare her availability for overtime. We will then see how the patterns can be changed or deleted.
Add an Availability Pattern
For example, Jen should adhere to the following weekly shift pattern starting on her hire date, which is August 1, 2018. This pattern is open-ended, until a closed date is provided.
- Monday - 2:00 PM to 10:00 PM (2 short breaks, 1 long break between 7:00 PM and 8:00 PM)
- Tuesday - No shift
- Wednesday - 3:00 PM to 6:15 PM (1 short break)
- Thursday - No shift
- Friday - 8:00 AM to 4:00 PM (2 short breaks, 1 long break between 12:00 PM and 1:00 PM)
- Saturday - 6:00 PM to 10:15 PM (1 short break)
Example URL
The following is the format of the resource URL.
POST
/hcmRestApi/resources/11.13.18.05/availabilityPatterns
Example Request
The following is an example of the request body in JSON format.
{
"PersonId": "100010026711792",
"AssignmentId": "100010026711804",
"AvailabilityTypeId": "300100156695374",
"DateFrom":"2018-08-01",
"shifts":[{
"PatternOrException":"PATTERN",
"DayOfWeek":"2",
"StartTime":"14:00",
"EndTime":"22:00",
"breaks":[{
"BreakName": "Tea 1"
},{
"BreakName": "Lunch",
"StartTime":"19:00",
"EndTime":"20:00"
},{
"BreakName": "Tea 2"
}]
},{
"PatternOrException":"PATTERN",
"DayOfWeek":"4",
"StartTime":"15:00",
"EndTime":"18:15",
"breaks":[{
"BreakName": "Tea 1"
}]
},{
"PatternOrException":"PATTERN",
"DayOfWeek":"6",
"StartTime":"08:00",
"EndTime":"16:00",
"breaks":[{
"BreakName": "Tea 1"
},{
"BreakName": "Lunch",
"StartTime":"12:00",
"EndTime":"13:00"
},{
"BreakName": "Tea 2"
}]
},{
"PatternOrException":"PATTERN",
"DayOfWeek":"7",
"StartTime":"18:00",
"EndTime":"22:15",
"breaks":[{
"BreakName": "Tea 1"
}]
}]
}
Example Response
The following is an example of the response body in JSON format.
{
"AssignmentAvailabilityId": 300100092219780,
"AssignmentId": 100010026711804,
"AnchorDate": null,
"PersonId": 100010026711792,
"AvailabilityTypeId": 300100156695374,
"DateFrom": "2018-08-01",
"DateTo": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:19-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.223-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"AssignmentNumber": "10026711802",
"AvailabilityType": "PJ_REST_STEND_Brk_PAID",
"ShiftCount": 1,
"ScheduledDuration": "23.500",
"PaidBreakDuration": "0.0",
"UnpaidBreakDuration": "2.500",
"PaidDuration": "21.000",
"PersonNumber": "10026711792",
"shifts": [
{
"AvailabilityDetailId": 300100092219781,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 2,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "14:00",
"EndTime": "22:00",
"Duration": "8.000",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219782,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219783,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "19:00",
"EndTime": "20:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219784,
"BreakId": 300100156695401,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:29.523-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.664-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 2",
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219785,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 4,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "15:00",
"EndTime": "18:15",
"Duration": "3.250",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219786,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219787,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 6,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "08:00",
"EndTime": "16:00",
"Duration": "8.000",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219788,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219789,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "12:00",
"EndTime": "13:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219790,
"BreakId": 300100156695401,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:29.523-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.664-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 2",
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219791,
"AssignmentAvailabilityId": 300100092219781,
"DayOfWeek": 7,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "18:00",
"EndTime": "22:15",
"Duration": "4.250",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219792,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219792",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219792",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219792/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/PersonVA",
"name": "PersonVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/PerAssignmentsVA",
"name": "PerAssignmentsVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/AvailabilityTypeVA",
"name": "AvailabilityTypeVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts",
"name": "shifts",
"kind": "collection"
}
]
}
Edit an Existing Availability
Gretchen is informed that Jen can begin work only on August 3, 2018. So Gretchen changes the start-date of the pattern.
Example URL
The following is the format of the resource URL.
PATCH
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}
Example Request
The following is an example of the request body in JSON format.
{
"DateFrom": "2018-08-03"
}
Example response
The following is an example of the response body in JSON format.
{
"AssignmentAvailabilityId": 300100092219780,
"AssignmentId": 100010026711804,
"AnchorDate": null,
"PersonId": 100010026711792,
"AvailabilityTypeId": 300100156695374,
"DateFrom": "2018-08-03",
"DateTo": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:19-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.223-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"AssignmentNumber": "10026711802",
"AvailabilityType": "PJ_REST_STEND_Brk_PAID",
"ShiftCount": 1,
"ScheduledDuration": "23.500",
"PaidBreakDuration": "0.0",
"UnpaidBreakDuration": "2.500",
"PaidDuration": "21.000",
"PersonNumber": "10026711792",
"shifts": [
{
"AvailabilityDetailId": 300100092219781,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 2,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "14:00",
"EndTime": "22:00",
"Duration": "8.000",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219782,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219783,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "19:00",
"EndTime": "20:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219784,
"BreakId": 300100156695401,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:29.523-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.664-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 2",
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219785,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 4,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "15:00",
"EndTime": "18:15",
"Duration": "3.250",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219786,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219787,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 6,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "08:00",
"EndTime": "16:00",
"Duration": "8.000",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219788,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219789,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "12:00",
"EndTime": "13:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219790,
"BreakId": 300100156695401,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:29.523-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.664-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 2",
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219791,
"AssignmentAvailabilityId": 300100092219781,
"DayOfWeek": 7,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "18:00",
"EndTime": "22:15",
"Duration": "4.250",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219792,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219792",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219792",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219792/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219793,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 2,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "14:00",
"EndTime": "22:00",
"Duration": "8.000",
"breaks": null,
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219794,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 2,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "14:00",
"EndTime": "22:00",
"Duration": "8.000",
"breaks": null,
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219794",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219794",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219794/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219794/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/PersonVA",
"name": "PersonVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/PerAssignmentsVA",
"name": "PerAssignmentsVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/AvailabilityTypeVA",
"name": "AvailabilityTypeVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts",
"name": "shifts",
"kind": "collection"
}
]
}
Add a Shift to an Existing Availability Pattern
Jen decides she wants to declare that she's available for overtime work on Thursday. So she adds an overtime shift from 8:00 AM to 6:00 PM on Thursday.
Example URL
The following is the format of the resource URL.
POST
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}/child/shifts
Example Request
The following is an example of the request body in JSON format.
{
"PatternOrException":"EXCEPTION",
"DayOfWeek":"5",
"StartTime":"08:00",
"EndTime":"18:00"
}
Example Response
The following is an example of the response body in JSON format.
{
"AvailabilityDetailId": 300100092219795,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 5,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "08:00",
"EndTime": "18:00",
"Duration": "10.000",
"breaks": null,
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
}
Edit an Existing Shift on an Availability Pattern
Jen wants to change her overtime availability on Thursday from 8:00 AM to 6:00 PM to 12:00 PM to 10:00 PM.
Example URL
The following is the format of the resource URL.
PATCH
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}/child/shifts/{availabilityDetailId}
Example Request
The following is an example of the request body in JSON format.
{
"StartTime":"12:00",
"EndTime":"22:00"
}
Example Response
The following is an example of the response body in JSON format.
{
"AvailabilityDetailId": 300100092219795,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 5,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "12:00",
"EndTime": "22:00",
"Duration": "10.000",
"breaks": null,
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219795/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
}
Delete an Existing Shift on an Availability Pattern
Jen enrolls in a training program on Thursdays. So she wants to remove the overtime availability she declared.
Example URL
The following is the format of the resource URL.
DELETE
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}/child/shifts/{availabilityDetailId}
Example Response
The following is an example of the response body in JSON format.
204 - No content
Add a Break to an Existing Shift
Gretchen decides to add a second small break to Jen's shift on Saturday.
Example URL
The following is the format of the resource URL.
POST
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}/child/shifts/{availabilityDetailId}/child/breaks
Example Request
The following is an example of the request body in JSON format.
{
"BreakName": "Tea 1"
}
Example Response
The following is an example of the response body in JSON format.
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219796,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219796",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219796",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219796/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
Edit an Existing Break on an Existing Shift
Gretchen decides to move the long break's range from 1:00 PM to 2:00 PM for Jen's Friday shift.
Example URL
The following is the format of the resource URL.
PATCH
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}/child/shifts/{availabilityDetailId}/child/breaks/{availabilityDetailId}
Example Request
The following is an example of the request body in JSON format.
{
"StartTime": "13:00",
"EndTime": "14:00"
}
Example Response
The following is an example of the response body in JSON format.
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219789,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "13:00",
"EndTime": "14:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
Delete an Existing Break to an Existing Shift.
Gretchen decides to remove the short break on Jen's Saturday shift.
Example URL
The following is the format of the resource URL.
DELETE
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{assignmentAvailabilityId}/child/shifts/{availabilityDetailIdofSHIFT}/child/shifts/{AvailabilityDetailIdofBREAK}
Retrieve an Employee's Availability Pattern
Gretchen had made several changes to Jen's availability pattern. She wants to now retrieve Jen's core hours that are effective today. So, she passes in Jen's Person ID, which is a unique identifier of the employee, and the Availability Type ID of core hours, which is a unique identifier of the availability type.
Example URL
The following is the format of the resource URL.
GET
/hcmRestApi/resources/11.13.18.05/availabilityPatterns?finder=findByPersonIdTypeIdEffectiveDate;PersonId={personId},AvailabilityTypeId={availabilityTypeId}
Example Response
The following is an example of the response body in JSON format.
{
"AssignmentAvailabilityId": 300100092219780,
"AssignmentId": 100010026711804,
"AnchorDate": null,
"PersonId": 100010026711792,
"AvailabilityTypeId": 300100156695374,
"DateFrom": "2018-08-01",
"DateTo": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:19-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.223-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"AssignmentNumber": "10026711802",
"AvailabilityType": "PJ_REST_STEND_Brk_PAID",
"ShiftCount": 1,
"ScheduledDuration": "23.500",
"PaidBreakDuration": "0.0",
"UnpaidBreakDuration": "2.500",
"PaidDuration": "21.000",
"PersonNumber": "10026711792",
"shifts": [
{
"AvailabilityDetailId": 300100092219781,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 2,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "14:00",
"EndTime": "22:00",
"Duration": "8.000",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219782,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219782/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219783,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "19:00",
"EndTime": "20:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219783/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219784,
"BreakId": 300100156695401,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:29.523-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.664-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 2",
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks/300100092219784/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219781/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219785,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 4,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "15:00",
"EndTime": "18:15",
"Duration": "3.250",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219786,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks/300100092219786/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219785/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219787,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 6,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "08:00",
"EndTime": "16:00",
"Duration": "8.000",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219788,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219788/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219789,
"BreakId": 300100156695382,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:25.492-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.413-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Lunch",
"StartTime": "13:00",
"EndTime": "14:00",
"Duration": "30",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219789/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
},
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219790,
"BreakId": 300100156695401,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:29.523-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.664-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 2",
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks/300100092219790/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219787/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219791,
"AssignmentAvailabilityId": 300100092219781,
"DayOfWeek": 7,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "18:00",
"EndTime": "22:15",
"Duration": "4.250",
"breaks": [
{
"AssignmentAvailabilityId": 300100092219780,
"AvailabilityDetailId": 300100092219796,
"BreakId": 300100156695377,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:21.409-07:00",
"LastUpdateDate": "2018-08-07T20:37:38.184-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"BreakName": "Tea 1"
"Duration": "15",
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219796",
"name": "breaks",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219796",
"name": "breaks",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks/300100092219796/lov/AvailTypeBreaksVA",
"name": "AvailTypeBreaksVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219791/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
},{
"AvailabilityDetailId": 300100092219793,
"AssignmentAvailabilityId": 300100092219780,
"DayOfWeek": 2,
"ExceptionDate": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2018-08-07T20:37:20.834-07:00",
"LastUpdateDate": "2018-08-07T20:37:37.829-07:00",
"LastUpdateLogin": "72CEB09F3DC14EEDE053C960930A6E67",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"ObjectVersionNumber": 1,
"PatternOrException": "PATTERN",
"StartTime": "14:00",
"EndTime": "22:00",
"Duration": "8.000",
"breaks": null,
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793",
"name": "shifts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793",
"name": "shifts",
"kind": "item"
},
{
"rel": "parent",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793/lov/HcmPatternExceptionLookupVA",
"name": "HcmPatternExceptionLookupVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts/300100092219793/child/breaks",
"name": "breaks",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780",
"name": "availabilityPatterns",
"kind": "item"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/PersonVA",
"name": "PersonVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/PerAssignmentsVA",
"name": "PerAssignmentsVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/lov/AvailabilityTypeVA",
"name": "AvailabilityTypeVA",
"kind": "collection"
},
{
"rel": "child",
"href": "http://<host>:<port>/hcmRestApi/resources/11.13.0.0/availabilityPatterns/300100092219780/child/shifts",
"name": "shifts",
"kind": "collection"
}
]
}