1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Allocated Checklists

Update an allocated checklist

patch

/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Allocated Checklists resource and used to uniquely identify an instance of Allocated Checklists. The client should not generate the hash key value. Instead, the client should query on the Allocated Checklists collection resource in order to navigate to a specific instance of Allocated Checklists to get the hash key.
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Allocated Tasks
Type: array
Title: Allocated Tasks
The allocatedtasks resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Allocated Tasks FlexFields
Type: array
Title: Allocated Tasks FlexFields
The allocatedChecklistTaskFlex resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks flexfields.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resources is a child of the allocatedChecklists resource. It is used to to view, create, and update attachments for a task.
Show Source
Nested Schema : Documents
Type: array
Title: Documents
The documents resource is a child of the allocatedChecklists resource. It is used to view, create, and update attachments for a document task type.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-allocatedChecklistTaskFlex-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : allocatedChecklists-item-response
Type: object
Show Source
Nested Schema : Allocated Tasks
Type: array
Title: Allocated Tasks
The allocatedtasks resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-item-response
Type: object
Show Source
Nested Schema : Allocated Tasks FlexFields
Type: array
Title: Allocated Tasks FlexFields
The allocatedChecklistTaskFlex resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks flexfields.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resources is a child of the allocatedChecklists resource. It is used to to view, create, and update attachments for a task.
Show Source
Nested Schema : Documents
Type: array
Title: Documents
The documents resource is a child of the allocatedChecklists resource. It is used to view, create, and update attachments for a document task type.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-allocatedChecklistTaskFlex-item-response
Type: object
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-attachments-item-response
Type: object
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-documents-item-response
Type: object
Show Source
Links
allocateNewTask
Parameters:
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
Allocates a task to a person using task name, task description, task type, action url, mandatory indicator.
allocateTaskFromTaskLibrary
Parameters:
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
Allocates a task from the task library to an existing checklist.
allocatedTasks
Parameters:
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
The allocatedtasks resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks.
forceCloseChecklist
Parameters:
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
Force closes an incomplete checklist.
Back to Top

Examples

The following example shows how to update an allocated checklist by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" PATCH -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/allocatedChecklists/300100031447538

Example of Payload

The following is an example of the payload.

{
 "ChecklistStatus": "COM"
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "ActionDate": null,
    "AllocatedChecklistId": 300100016023502,
    "AllocationDate": null,
    "ChecklistCategory": "ONBOARD",
    "ChecklistInstance": "1",
    "ChecklistName": "HIRE_A_NEW_EMPLOYEE",
    "ChecklistStatus": "COM",
    "CompletionDate": "2019-03-19",
    "LegislationCode": null,
    "ChecklistCode": "",
    "BaseChecklistId": 300100013625538,
    "PersonNumber": "955160008172962",
    "PersonId": 300100016018768,
    "DisplayName": "Jarad Thakur",
    "FullName": "Jarad Thakur",
    "links": [
              {
                ...}
  ]
}
Back to Top