Allocate a checklist
post
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/action/allocateChecklist
Allocates a checklist to a person using the checklist identifier or checklist name, category, person identifier or person number, and allocation date.
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
allocationDate: string
(date)
Date on which the checklist was allocated.
-
checklistCategory: string
Category of the checklist such as off boarding, onboarding and so on. Valid values are defined in the list CHECKLIST_CATEGORY LOV.
-
checklistId: number
Unique identifier for the checklist.
-
checklistName: string
Name of the checklist.
-
personId: number
Internal identifier for the person.
-
personNumber: string
Number assigned to a person to identify the person uniquely.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Examples
The following example shows how to allocate a checklist by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" POST -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/allocatedChecklists/action/allocateChecklist
Example of Payload
The following is an example of the payload.
{ "checklistName": "Oracle Onboarding", "checklistCategory": "ORA_ONB_ENT_ONBOARDING", "personNumber": "955160008190890", "allocationDate": "2019-02-01" }
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type: application/vnd.oracle.adf.actionresult+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
"AllocatedChecklistId": 300100031447538