Create a task property in an assigned journey
post
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties
Request
Path Parameters
-
WorkerJourneyId(required): integer(int64)
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=
-
tasksUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Tasks resource and used to uniquely identify an instance of Tasks. The client should not generate the hash key value. Instead, the client should query on the Tasks collection resource in order to navigate to a specific instance of Tasks 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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Category: string
Name of the group for journey template task property.
-
CategoryMeaning: string
Meaning of group for journey template task property.
-
Code: string
Property code of journey template task.
-
DisabledForLineManagerFlag: boolean
Indicates if journey template task property is disabled for line manager. Default value depends on the task type.
-
DisabledForOthersFlag: boolean
Indicates if the journey template task property is disabled for other users. Default value depends on the task type.
-
DisabledForOwnerFlag: boolean
Indicates if the journey template task property is disabled for owner. Default value depends on the task type.
-
DisabledForPerformerFlag: boolean
Indicates if the journey template task property is disabled for performer. Default value depends on the task type.
-
Level: string
Property level for the journey template task.
-
LineManagerDefaultValue: string
Default value of the journey template task property for line manager.
-
LineManagerLookupType: string
Journey template task property for performer. Lookup type of the journey template task property for line manager.
-
LineManagerValue: string
Value of the journey template task property for line manager.
-
Name: string
Name of the journey template task property.
-
OthersDefaultValue: string
Default value of the journey template task property for other user.
-
OthersLookupType: string
Journey template task property type for other user.
-
OthersValue: string
Property value of the journey template task for other user.
-
OverriddenFlag: boolean
Indicates if the journey template property is overridden. Default value depends on the task type.
-
OwnerDefaultValue: string
Default value of the journey template task property for owner.
-
OwnerLookupType: string
Journey template task property type for owner.
-
OwnerValue: string
Property value of the journey template task for owner.
-
PerformerDefaultValue: string
Default value of the journey template task property for performer.
-
PerformerLookupType: string
Journey template task property for performer.
-
PerformerValue: string
Property value of the journey template task for performer.
-
Sequence: integer
Sequence of the journey template task property.
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 : workerJourneys-tasks-properties-item-response
Type:
Show Source
object
-
Category: string
Name of the group for journey template task property.
-
CategoryMeaning: string
Meaning of group for journey template task property.
-
Code: string
Property code of journey template task.
-
DisabledForLineManagerFlag: boolean
Indicates if journey template task property is disabled for line manager. Default value depends on the task type.
-
DisabledForOthersFlag: boolean
Indicates if the journey template task property is disabled for other users. Default value depends on the task type.
-
DisabledForOwnerFlag: boolean
Indicates if the journey template task property is disabled for owner. Default value depends on the task type.
-
DisabledForPerformerFlag: boolean
Indicates if the journey template task property is disabled for performer. Default value depends on the task type.
-
Level: string
Property level for the journey template task.
-
LineManagerDefaultValue: string
Default value of the journey template task property for line manager.
-
LineManagerLookupType: string
Journey template task property for performer. Lookup type of the journey template task property for line manager.
-
LineManagerValue: string
Value of the journey template task property for line manager.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the journey template task property.
-
OthersDefaultValue: string
Default value of the journey template task property for other user.
-
OthersLookupType: string
Journey template task property type for other user.
-
OthersValue: string
Property value of the journey template task for other user.
-
OverriddenFlag: boolean
Indicates if the journey template property is overridden. Default value depends on the task type.
-
OwnerDefaultValue: string
Default value of the journey template task property for owner.
-
OwnerLookupType: string
Journey template task property type for owner.
-
OwnerValue: string
Property value of the journey template task for owner.
-
PerformerDefaultValue: string
Default value of the journey template task property for performer.
-
PerformerLookupType: string
Journey template task property for performer.
-
PerformerValue: string
Property value of the journey template task for performer.
-
Sequence: integer
Sequence of the journey template task property.
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.