1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Allocated Checklist
  4. Allocated Task

Update an allocated task

patch

/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key for the Allocated Checklist resource and used to uniquely identify an instance of Allocated Checklist. The client should not generate the hash key value. Instead, the client should query on the Allocated Checklist collection resource in order to navigate to a specific instance of Allocated Checklist 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 : allocatedChecklistTaskFlex
Type: array
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-allocatedChecklistTaskFlex-item-patch-request
Type: object
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-attachments-item-patch-request
Type: object
Show Source
Nested Schema : allocatedChecklists-allocatedTasks-documents-item-patch-request
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-allocatedTasks-item-response
Type: object
Show Source
Nested Schema : allocatedChecklistTaskFlex
Type: array
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
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
allocatedChecklistTaskFlex
Parameters:
  • AllocatedTaskId: $request.path.AllocatedTaskId
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
attachments
Parameters:
  • AllocatedTaskId: $request.path.AllocatedTaskId
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
The attachments resource is used to view, create, and update attachments.
documents
Parameters:
  • AllocatedTaskId: $request.path.AllocatedTaskId
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
The attachments resource is used to view, create, and update attachments.
reopenTask
Parameters:
  • AllocatedTaskId: $request.path.AllocatedTaskId
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
Reopens an already completed or not applicable task.
updateTaskStatus
Parameters:
  • AllocatedTaskId: $request.path.AllocatedTaskId
  • allocatedChecklistsUniqID: $request.path.allocatedChecklistsUniqID
Updates the existing task status to complete or not applicable.
Back to Top

Examples

The following example shows how to update an allocated 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/child/allocatedTasks/300100031447539/

Example of Payload

The following is an example of the payload.

{
        "Description": "Assign a Laptop to the new hire."
}

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.

{
    "ActionType": null,
    "ActionURL": null,
    "ActualEndDate": null,
    "ActualStartDate": null,
    "AllocatedChecklistId": 300100016023502,
    "AllocatedTaskId": 300100016023503,
    "Description": "Assign a Laptop to the new hire.",
    "TaskActionCode": null,
    "TaskName": "Assign a Laptop",
    "DependentOnTasks": null,
    "Status": "INI",
    "MandatoryFlag": true,
    "TaskSequence": null,
    "TargetEndDate": null,
    "TargetStartDate": "2012-12-27",
    "TaskOwnerName": "Brooklyn Anderson",
    "TaskOwnerPersonId": 100010024200642,
    "TaskOwnerUsername": "HR_SPEC_ALL",
    "ResponsibilityType": null,
    "ResponsibilityTypeGUID": null,
    "PerformerOrigSystemId": null,
    "PerformerOrigSystem": null,
    "OwnerRespType": null,
    "OwnerRespTypeUsers": null,
    "TaskInChecklistId": 300100013625539,
    "TaskConfiguration": null,
    "FlexContextCode": null,
    "CompletedBy": null,
    "CompletionDate": null,
    "TargetDurationUOM": null,
    "AbsAllocatedChecklistId": null,
    "DetailAllocChecklistId": null,
    "links": [
              {
                ...}
  ]
}
Back to Top