Update a journey assignment
patch
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}
Request
Path Parameters
-
journeyAllocationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Journey Allocations resource and used to uniquely identify an instance of Journey Allocations. The client should not generate the hash key value. Instead, the client should query on the Journey Allocations collection resource in order to navigate to a specific instance of Journey Allocations 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/json
Root Schema : schema
Type:
Show Source
object
-
criteria: array
Criteria
Title:
Criteria
The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey. -
EndDate: string
(date)
Date when the journey assignment ends.
-
workerCounts: array
Worker Counts
Title:
Worker Counts
The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation. -
workers: array
Workers
Title:
Workers
The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.
Nested Schema : Criteria
Type:
array
Title:
Criteria
The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.
Show Source
Nested Schema : Worker Counts
Type:
array
Title:
Worker Counts
The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.
Show Source
Nested Schema : Workers
Type:
array
Title:
Workers
The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.
Show Source
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : journeyAllocations-item-response
Type:
Show Source
object
-
AssignedDate: string
(date)
Date when the journey was assigned.
-
Comments: string
Maximum Length:
4000
Comments provided for the journey assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the journey assignment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the journey assignment is created. -
criteria: array
Criteria
Title:
Criteria
The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey. -
EndDate: string
(date)
Date when the journey assignment ends.
-
InitiationDate: string
(date)
Read Only:
true
Date when the journey allocation is initiated. -
InitiatorDisplayName: string
Read Only:
true
Maximum Length:240
Name of the person who initiated the journey assignment. -
InitiatorPersonId: integer
(int64)
Read Only:
true
Unique identifier of the person who initiated the journey assignment. -
InitiatorPersonNumber: string
Read Only:
true
Maximum Length:30
Person number of the person who initiated the journey assignment. -
JourneyAllocationId: integer
(int64)
Read Only:
true
Unique identifier of the journey assignment. -
JourneyCategory: string
Title:
Category
Read Only:true
Maximum Length:60
Category of the journey. -
JourneyCategoryMeaning: string
Read Only:
true
Meaning of journey category. -
JourneyId: integer
(int64)
Unique identifier of the journey.
-
JourneyName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the journey. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the journey assignment was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the journey assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:4000
Name of the activity. -
PopulationCount: integer
(int32)
Read Only:
true
Default Value:-1
Number of users the journey is assigned to. -
ProcessingStatus: string
Read Only:
true
Maximum Length:30
Default Value:ORA_PENDING
Processing status of the journey assignment. -
ProcessingStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the processing status for an assigned journey. -
Source: string
Read Only:
true
Maximum Length:30
Default Value:ORA_MANUAL
Source of journey assignment. -
SourceMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Source meaning of journey assignment. -
StatusCategory: string
Read Only:
true
Maximum Length:80
Status category of journey assignment. -
StatusCategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status category meaning of journey assignment. -
SubmitFlag: boolean
Default Value:
true
Indicates whether the journey assignment is submitted. Valid values are true (enabled) and false (disabled). The default value is false (disabled). -
workerCounts: array
Worker Counts
Title:
Worker Counts
The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation. -
workers: array
Workers
Title:
Workers
The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.
Nested Schema : Criteria
Type:
array
Title:
Criteria
The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Worker Counts
Type:
array
Title:
Worker Counts
The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.
Show Source
Nested Schema : Workers
Type:
array
Title:
Workers
The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.
Show Source
Nested Schema : journeyAllocations-criteria-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Assignment identifier criteria in journey assignment.
-
AssignmentName: string
Read Only:
true
Maximum Length:255
Assignment name criteria in journey assignment. -
AssignmentNumber: string
Read Only:
true
Maximum Length:255
Assignment number criteria in journey assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the journey assignment criteria. -
CreationDate: string
(date-time)
Read Only:
true
Date when the journey assignment criteria is created. -
DisplayName: string
Read Only:
true
Maximum Length:240
Name of the person who provided journey assignment criteria. -
ExcludeFlag: boolean
Read Only:
true
Maximum Length:4
Default Value:false
Indicates whether a journey assignment based on a criteria needs to be excluded. Valid values are true (enabled) and false (disabled). The default value is false (disabled). -
JourneyAllocationCriteriaId: integer
(int64)
Read Only:
true
Unique identifier of the journey assignment criteria. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date on which the journey assignment criteria was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the journey assignment criteria. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListId: integer
(int64)
List identifier of the criteria of the journey schedule allocation generated by the application.
-
ListName: string
Read Only:
true
Maximum Length:200
Display name of the list used in the criteria of the scheduled journey allocation. -
PersonId: integer
(int64)
Unique identifier of the person who provided the journey assignment criteria.
-
ProcessedFlag: boolean
Read Only:
true
Maximum Length:4
Default Value:false
Indicates whether the journey assignment based on criteria is processed. Valid values are true (enabled) and false (disabled). The default value is false (disabled). -
Type: string
Maximum Length:
30
Default Value:ORA_PERSON
Journey assignment criteria type. -
TypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of type in journey assignment criteria.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : journeyAllocations-workerCounts-item-response
Type:
Show Source
object
-
CompletedWorkers: integer
Read Only:
true
Count of workers for whom journey assignment completed. -
FailedWorkers: integer
Read Only:
true
Count of workers for whom journey assignment failed. -
JourneyAllocationId: integer
Read Only:
true
Unique identifier of the journey assignment count. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PendingWorkers: integer
Read Only:
true
Count of workers for whom journey assignment is pending. -
TotalWorkers: integer
Read Only:
true
Total count of workers for whom journey assignment is processed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : journeyAllocations-workers-item-response
Type:
Show Source
object
-
AllocationDetails: string
Read Only:
true
Maximum Length:1000
Assignment details for worker to whom journey is assigned. -
AllocationStatus: string
Read Only:
true
Maximum Length:30
Assignment status for worker to whom journey is assigned. -
AllocationStatusMeaning: string
Read Only:
true
Maximum Length:80
Assignment status meaning for worker to whom journey is assigned. -
AssignmentId: integer
(int64)
Read Only:
true
Assignment identifier of worker to whom journey is assigned. -
AssignmentName: string
Read Only:
true
Maximum Length:80
Assignment name of worker to whom journey is assigned. -
AssignmentNumber: string
Read Only:
true
Maximum Length:50
Assignment number of worker to whom journey is assigned. -
DisplayName: string
Read Only:
true
Maximum Length:240
Display name of worker to whom journey is assigned. -
ErrorDetails: string
(byte)
Read Only:
true
Details of error for a worker to whom journey is assigned. -
JourneyAllocationWorkerId: integer
(int64)
Read Only:
true
Unique identifier of the worker to whom journey is assigned. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
Unique identifier of the person to whom journey is assigned. -
PersonNumber: string
Read Only:
true
Maximum Length:30
Person number of the person to whom journey is assigned. -
ProcessingStatus: string
Read Only:
true
Maximum Length:30
Processing status of the journey assignment for a worker. -
ProcessingStatusMeaning: string
Read Only:
true
Maximum Length:80
Processing status meaning of the journey assignment for a worker.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- criteria
-
Operation: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteriaParameters:
- journeyAllocationsUniqID:
$request.path.journeyAllocationsUniqID
The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey. - journeyAllocationsUniqID:
- workerCounts
-
Operation: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCountsParameters:
- journeyAllocationsUniqID:
$request.path.journeyAllocationsUniqID
The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation. - journeyAllocationsUniqID:
- workers
-
Operation: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workersParameters:
- journeyAllocationsUniqID:
$request.path.journeyAllocationsUniqID
The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria. - journeyAllocationsUniqID: