Update a journey assignment based on criteria
patch
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria/{criteriaUniqID}
Request
Path Parameters
-
criteriaUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Criteria resource and used to uniquely identify an instance of Criteria. The client should not generate the hash key value. Instead, the client should query on the Criteria collection resource in order to navigate to a specific instance of Criteria to get the hash key.
-
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
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-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.