Get a step task in a journey template
get
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks/{JourneyTaskId}
Request
Path Parameters
-
JourneyId(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=
-
JourneyTaskId(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : journeys-allStepTasks-item-response
Type:
Show Source
object
-
ActionURL: string
Read Only:
true
Maximum Length:1000
The URL associated with the task that's entered on the setup screen. To retrieve a navigable URL, use the getNavigationURL custom method of the resource. -
AllowAttachmentFlag: boolean
Read Only:
true
Indicates whether attachments can be added to the task. Valid values are Yes or No. The default is No. -
AllowCommentFlag: boolean
Read Only:
true
Indicates whether comments can be added to the task. Valid values are Yes or No. The default is No. -
AllowNoteTitleFlag: boolean
Read Only:
true
Indicates whether the Notes title can be added. Valid values are Yes or No. The default is No. -
DelayDuration: integer
(int32)
Read Only:
true
Delay duration for the task. -
DelayDurationUOM: string
Read Only:
true
Maximum Length:30
Unit of measure used in specifying delaying the duration. -
DelayDurationUOMMeaning: string
Read Only:
true
Maximum Length:80
Meaning of unit of measure used in delay duration. -
DependentTaskId: integer
(int64)
Read Only:
true
Primary key or unique identifier of the dependent task. -
DependentTaskName: string
Read Only:
true
Maximum Length:240
Name of the dependent task. -
Description: string
Read Only:
true
Maximum Length:4000
Description of the task. -
JourneyTaskId: integer
(int64)
Read Only:
true
Unique identifier of the journey task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:240
Name of the journey task. -
Notes: string
(byte)
Read Only:
true
Notes for the task. The notes text is stored as a CLOB object. To use in the payload, the text should be converted to a base64 encoded string using either a conversion tool or a prerequisite script. -
NoteTitle: string
Read Only:
true
Maximum Length:150
Title of the notes. -
OpenInSamePageFlag: boolean
Read Only:
true
Indicates whether the external URL should open in the existing page or a new page. Valid values are Yes and No. The default value is No. -
OwnerType: string
Read Only:
true
Maximum Length:30
Task owner type. -
OwnerTypeMeaning: string
Read Only:
true
Maximum Length:80
Task owner type meaning. -
ParentJourneyId: integer
(int64)
Read Only:
true
Identifier of the parent journey. In case of enterprise onboarding checklist this will point to the enterprise onboarding checklist in other cases it will be null. -
ParentJourneyName: string
Read Only:
true
Maximum Length:240
Name of the parent journey template. -
PerformerType: string
Read Only:
true
Maximum Length:30
Task performer type. -
PerformerTypeMeaning: string
Read Only:
true
Maximum Length:80
Task performer type meaning. -
QuestionnaireId: integer
(int64)
Read Only:
true
Internal identifier of the questionnaire. -
RequiredFlag: boolean
Read Only:
true
Maximum Length:30
Indicates whether the task is mandatory or optional. Valid values are Yes and No. Default is No. -
Sequence: number
Read Only:
true
Task display ordering sequence. Default is 1. -
StageId: integer
(int64)
Read Only:
true
Unique identifier of the journey step. -
StageName: string
Read Only:
true
Maximum Length:240
Name of the journey step. -
StageSequence: number
Read Only:
true
Sequence of the journey step. -
Status: string
Read Only:
true
Maximum Length:30
Code for the task status. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Status of the task. -
SubType: string
Read Only:
true
Maximum Length:30
Task action subtype code. Available only for action types I-9 and Electronic Signature. -
SubTypeMeaning: string
Read Only:
true
Maximum Length:80
Task action subtype. Available only for action types I9 and Electronic Signature. -
TargetDuration: integer
(int32)
Read Only:
true
Target duration for the task. -
TargetDurationUOM: string
Read Only:
true
Maximum Length:30
Unit of measure for the target duration. -
TargetDurationUOMMeaning: string
Read Only:
true
Maximum Length:80
Meaning of the unit of measure used in the target duration. -
Type: string
Read Only:
true
Maximum Length:30
Task action type code. -
TypeMeaning: string
Read Only:
true
Maximum Length:80
Task action type.
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.