|
Assignments
Inserts or updates time off request details as an assignment record.
Request Keys
The following keys are available to use for the time off to assignment integration.
- CorrelationId - The assignment's unique identifier that links it to a time off request in a third-party HCM application.
- ResourceCorrelationId - The resource's unique identifier that links them to a third-party HCM application.
- RequestStatus - The status of the time off request, such as Approved or Canceled.
- RequestDates - Details of each date in the time off request.
- Date - The individual date in the time off request.
- DateStatus - The status of the date, such as Approved or Canceled.
- Policy - The policy associated with the date.
- Unit - The unit of measurement associated with the date, such as days or hours.
- Quantity - The amount of time off requested for the date.
You must use the date format YYYY-MM-DD, such as 2018-04-24.
Response Keys
The following keys are used in the response.
- CorrelationId - The assignment's unique identifier that links it to a time off request in a third-party HCM application.
- Message - The message returned when an error occurs in a processing request.
POST
| URI |
/services/apexrest/pse/v1.0/assignments/* |
| Description |
Inserts time off request details as an assignment record. |
Sample Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | [{
"CorrelationId": "93847jdue7",
"ResourceCorrelationId": "102420171",
"RequestStatus": "Approved",
"RequestDates": [{
"Date": "2017-11-15",
"DateStatus": "Approved",
"Policy": "Vacation",
"Unit": "days",
"Quantity": "1"
}]
},
{
"CorrelationId": "93847jdue0",
"ResourceCorrelationId": "102820171",
"RequestStatus": "Approved",
"RequestDates": [{
"Date": "2017-11-16",
"DateStatus": "Approved",
"Policy": "Vacation",
"Unit": "hours",
"Quantity": "8"
},{
"Date": "2017-11-17",
"DateStatus": "Approved",
"Policy": "Sick",
"Unit": "days",
"Quantity": "1"
}]
}]
HTTP/1.1 200 OK
[{
"CorrelationId": "93847jdue7",
"ResourceCorrelationId": "102420171",
"RequestDates": [{
"Date": "2017-11-15",
"DateStatus": "Approved",
"Policy": "Vacation",
"Unit": "days",
"Quantity": "1"
}]
}]
HTTP/1.1 400 Bad Request
[{
"CorrelationId": "93847jdue7",
"Message": "You must enter a RequestStatus value. Contact your administrator."
}]
|
PATCH
| URI |
/services/apexrest/pse/v1.0/assignments/* |
| Description |
Inserts or updates time off request details as an assignment record. |
Sample Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | [{
"CorrelationId": "93847jdue7",
"ResourceCorrelationId": "102420171",
"RequestStatus": "Approved",
"RequestDates": [{
"Date": "2017-11-15",
"DateStatus": "Approved",
"Policy": "Vacation",
"Unit": "days",
"Quantity": "1"
}]
},
{
"CorrelationId": "93847jdue0",
"ResourceCorrelationId": "102820171",
"RequestStatus": "Approved",
"RequestDates": [{
"Date": "2017-11-16",
"DateStatus": "Approved",
"Policy": "Vacation",
"Unit": "hours",
"Quantity": "8"
},{
"Date": "2017-11-17",
"DateStatus": "Approved",
"Policy": "Sick",
"Unit": "days",
"Quantity": "1"
}]
}]
HTTP/1.1 200 OK
[{
"CorrelationId": "93847jdue7",
"ResourceCorrelationId": "102420171",
"RequestDates": [{
"Date": "2017-11-15",
"DateStatus": "Approved",
"Policy": "Vacation",
"Unit": "days",
"Quantity": "1"
}]
}]
HTTP/1.1 400 Bad Request
[{
"CorrelationId": "93847jdue7",
"Message": "You must enter a RequestStatus value. Contact your administrator."
}]
|
|
