Allocate a journey
post
/hcmRestApi/resources/11.13.18.05/workerJourneys/action/assignJourney
Allocates a journey to a worker.
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 when the journey was assigned.
-
AssignmentId: number
Assignment identifier for the journey assignee.
-
AssignmentNumber: string
Assignment number of the journey assignee.
-
AsyncFlag: boolean
Indicates whether to assign journey synchronously or asynchronously. Default is N and indicates asynchronous.
-
Comments: string
Comments for the journey.
-
Description: string
Description of the journey.
-
PersonId: number
Person identifier for the journey assignee.
-
PersonNumber: string
Person number of the journey assignee.
-
TaskExclusions: array
TaskExclusions
Tasks excluded from the journey.
-
TemplateCategory: string
Category of the journey template.
-
TemplateCountry: string
Country to which the journey template is applicable.
-
TemplateId: number
Identifier for the journey template.
-
TemplateName: string
Name of the journey template.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): number
Unique identifier for the worker journey.