Create a task property
post
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/properties
Request
Path Parameters
-
workerJourneyTasksUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Worker Journey Tasks resource and used to uniquely identify an instance of Worker Journey Tasks. The client should not generate the hash key value. Instead, the client should query on the Worker Journey Tasks collection resource in order to navigate to a specific instance of Worker Journey 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 the journey task property.
-
CategoryMeaning: string
Meaning of the group for the journey task property.
-
Code: string
Code of the journey task property.
-
DisabledForLineManagerFlag: boolean
Indicates if the journey task property is disabled for line manager.
-
DisabledForOthersFlag: boolean
Indicates if the journey task property is disabled for other users.
-
DisabledForOwnerFlag: boolean
Indicates if the journey task property is disabled for task owner.
-
DisabledForPerformerFlag: boolean
Indicates if the journey task property is disabled for task performer.
-
Level: string
Level of the journey task property.
-
LineManagerDefaultValue: string
Default value of the journey task property for line manager.
-
LineManagerLookupType: string
Journey task property type for line manager.
-
LineManagerValue: string
Value of the journey task property for line manager.
-
Name: string
Name of the journey task property.
-
OthersDefaultValue: string
Default value of the journey task property for other user.
-
OthersLookupType: string
Journey task property type for other user.
-
OthersValue: string
Value of the journey task property for other user.
-
OverriddenFlag: boolean
Indicates if the journey task property is overridden.
-
OwnerDefaultValue: string
Default value of the journey task property for task owner.
-
OwnerLookupType: string
Journey task property type for task owner.
-
OwnerValue: string
Value of the journey task property for task owner.
-
PerformerDefaultValue: string
Default value of the journey task property for task performer.
-
PerformerLookupType: string
Journey task property type for task performer.
-
PerformerValue: string
Value of the journey task property for task performer.
-
Sequence: integer
Display order of the 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 : workerJourneyTasks-properties-item-response
Type:
Show Source
object
-
Category: string
Name of the group for the journey task property.
-
CategoryMeaning: string
Meaning of the group for the journey task property.
-
Code: string
Code of the journey task property.
-
DisabledForLineManagerFlag: boolean
Indicates if the journey task property is disabled for line manager.
-
DisabledForOthersFlag: boolean
Indicates if the journey task property is disabled for other users.
-
DisabledForOwnerFlag: boolean
Indicates if the journey task property is disabled for task owner.
-
DisabledForPerformerFlag: boolean
Indicates if the journey task property is disabled for task performer.
-
Level: string
Level of the journey task property.
-
LineManagerDefaultValue: string
Default value of the journey task property for line manager.
-
LineManagerLookupType: string
Journey task property type for line manager.
-
LineManagerValue: string
Value of the journey task property for line manager.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the journey task property.
-
OthersDefaultValue: string
Default value of the journey task property for other user.
-
OthersLookupType: string
Journey task property type for other user.
-
OthersValue: string
Value of the journey task property for other user.
-
OverriddenFlag: boolean
Indicates if the journey task property is overridden.
-
OwnerDefaultValue: string
Default value of the journey task property for task owner.
-
OwnerLookupType: string
Journey task property type for task owner.
-
OwnerValue: string
Value of the journey task property for task owner.
-
PerformerDefaultValue: string
Default value of the journey task property for task performer.
-
PerformerLookupType: string
Journey task property type for task performer.
-
PerformerValue: string
Value of the journey task property for task performer.
-
Sequence: integer
Display order of the 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.