Jump to

• Request
• Response

Allocate a new task

post

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

Allocates a task to a person using task name, task description, task type, action url, mandatory indicator.

Request

Path Parameters

• allocatedChecklistsUniqID(required): string
  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

• 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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• actionType: string
  Indicates the task type, whether it's a manual task or external URL.
• actionUrl: string
  Url required for the task type external URL.
• description: string
  Description of the task.
• mandatoryFlag: string
  Indicates whether the task is mandatory or optional. Valid values are Yes and No.
• status: string
  Status of the task.
• targetEndDate: string (date)
  End date of the task.
• targetStartDate: string (date)
  Start date of the task.
• taskName: string
  Name of the task.

{
    "type":"object",
    "properties":{
        "actionType":{
            "type":"string",
            "description":"Indicates the task type, whether it's a manual task or external URL.",
            "nullable":true
        },
        "targetStartDate":{
            "type":"string",
            "description":"Start date of the task.",
            "format":"date",
            "nullable":true
        },
        "targetEndDate":{
            "type":"string",
            "description":"End date of the task.",
            "format":"date",
            "nullable":true
        },
        "actionUrl":{
            "type":"string",
            "description":"Url required for the task type external URL.",
            "nullable":true
        },
        "description":{
            "type":"string",
            "description":"Description of the task.",
            "nullable":true
        },
        "taskName":{
            "type":"string",
            "description":"Name of the task.",
            "nullable":true
        },
        "mandatoryFlag":{
            "type":"string",
            "description":"Indicates whether the task is mandatory or optional. Valid values are Yes and No.",
            "nullable":true
        },
        "status":{
            "type":"string",
            "description":"Status of the task.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Success or error message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Success or error message."
        }
    },
    "additionalProperties":false
}

Back to Top