Get all step tasks
get
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks
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=
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all journey step tasks that match the primary key specified.
Finder Variables- WorkerJourneyTaskId; integer; Unique identifier of the journey task.
- findAvailableOthersTasks Finds all journey tasks except deferred tasks for performers other than assignee and signed in user.
Finder Variables- mPerformerPersonId; integer; Unique identifier for the performer other than assigned and signed in user to whom all tasks except deferred tasks are assigned in a journey step.
- mPerformerUserguid; string; Internal identifier for the performer other than assignee and signed in user to whom all tasks except deferred tasks are assigned in a journey step.
- mPerformerUsername; string; User name of the performer other than assignee and signed in user for whom all tasks except deferred tasks are assigned in a journey step.
- mPersonId; integer; Identifier for the performer other than assignee and signed in user for whom all tasks except deferred tasks are assigned in a journey step.
- mUserguid; string; Unique identifier for the performer other than assignee and signed in user for whom all tasks except deferred tasks are assigned in a journey step.
- mUsername; string; User name of the worker other than assignee and signed in user for whom all tasks except deferred tasks are assigned in a journey step.
- findAvailableSelfTasks Finds all journey tasks except deferred tasks for the signed in user.
Finder Variables - findOthersIncludingAssigneeTasks Finds all journey tasks for performers including the journey assignee.
Finder Variables - findOthersTasks Finds all journey tasks for performers other than assignee and signed in user.
Finder Variables - findSelfTasks Finds all journey tasks for the signed in user.
Finder Variables - findWorkerTasks Finds all journey tasks for the journey assignee.
Finder Variables
- PrimaryKey Finds all journey step tasks that match the primary key specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Name; string; Name of the journey task.
- ParentWorkerJourneyId; integer; Unique identifier of the parent enterprise onboarding checklist.
- PerformerPersonId; integer; Person identifier of the task performer. Applicable only in case of a single task performer.
- RequiredFlag; boolean; Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
- Status; string; Code for the task status.
- WorkerJourneyTaskId; integer; Unique identifier of the journey task.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : workerJourneys-allStepTasks
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workerJourneys-allStepTasks-item-response
Type:
Show Source
object
-
AccessActivity: string
Title:
Access Task
Read Only:true
Setting that determines if the signed in user can access the task. -
AccessAttachments: string
Title:
Access Attachments
Read Only:true
Setting that determines if the signed in user can access the task attachments. -
AccessComments: string
Title:
Access Comments
Read Only:true
Setting that determines if the signed in user can access the task comments. -
AccessContact: string
Title:
Access Contact Information
Read Only:true
Setting that determines if the signed in user can access the task contact details. -
AccessNotes: string
Title:
Access Notes
Read Only:true
Setting that determines if the signed in user can access the task notes. -
ActionComplete: string
Title:
Mark as Complete
Read Only:true
Setting that determines if the signed in user can mark the task as complete. -
ActionEdit: string
Title:
Edit
Read Only:true
Setting that determines if the signed in user can edit the task. -
ActionEditDueDate: string
Title:
Edit Due Date
Read Only:true
Setting that determines if the signed in user can edit the due date of the task. -
ActionReassign: string
Title:
Reassign
Read Only:true
Setting that determines if the signed in user can reassign the task. -
ActionReject: string
Title:
Mark as Not Applicable
Read Only:true
Setting that determines if the signed in user can mark the task as not applicable. -
ActionRemove: string
Title:
Remove
Read Only:true
Setting that determines if the signed in user can remove the task. -
ActionReopen: string
Title:
Reopen
Read Only:true
Setting that determines if the signed in user can reopen a completed task. -
ActionSendReminder: string
Title:
Send Reminder
Read Only:true
Setting that determines if the signed in user can send a reminder for a task. -
ActionURL: string
Title:
URL
Read Only:true
Maximum Length:1000
URL associated with the task that's entered on the setup screen. -
ActualEndDate: string
(date)
Title:
Actual End Date
Read Only:true
End date of the task. -
ActualStartDate: string
(date)
Title:
Actual Start Date
Read Only:true
Date on which the task was opened. -
AllowAttachmentFlag: boolean
Title:
Allow Attachments
Read Only:true
Indicates whether attachments are enabled for a task. Valid values are Yes and No. The default value is No. -
AllowCommentFlag: boolean
Title:
Allow Comments
Read Only:true
Indicates whether comments are enabled for a task. Valid values are Yes and No. The default value is No. -
AllowNotesContentFlag: boolean
Read Only:
true
Indicates whether rich content can be added for notes. Valid values are Yes or No. The default is Yes. -
AllowNoteTitleFlag: boolean
Title:
Enable Notes Title
Read Only:true
Indicates whether the Notes title is hidden or not. Valid values are Yes and No. The default value is No. -
ApplicationTaskName: string
Title:
Application Task
Read Only:true
Display name of the application task. -
Comments: string
Title:
Comments
Read Only:true
Maximum Length:4000
Comments for the task. -
CompletedByDisplayName: string
Title:
Completed by Person Name
Read Only:true
Name of the person who completed the task. -
CompletedByPersonId: integer
Title:
Completed by Person ID
Read Only:true
Person identifier of the person who completed the task. -
CompletionDate: string
(date)
Title:
Completed On
Read Only:true
Date on which the task was completed. -
ConfigurableFormContext: string
Title:
Configurable Form
Read Only:true
Maximum Length:80
Descriptive flexfield context code for configurable form task type. -
ContentProviderCode: string
Read Only:
true
Maximum Length:240
Code of the user-defined content task. -
DeferredStartDate: string
(date)
Title:
Deferred Task Start Date
Read Only:true
Start date for the deferred task. -
DependentTaskId: integer
(int64)
Title:
Preceding Task ID
Read Only:true
Primary key or unique identifier of the dependent task. -
DependentTaskName: string
Title:
Preceding Task
Read Only:true
Maximum Length:240
Name of the dependent task. -
Description: string
Title:
Description
Read Only:true
Maximum Length:4000
Description of the task. -
EmbeddedApplicationTaskCode: string
Read Only:
true
Maximum Length:240
Code of the embedded application task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the journey task. -
Notes: string
(byte)
Title:
Notes
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
Title:
Notes Title
Read Only:true
Maximum Length:150
Title of the Notes section in the task. -
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. -
OpenReportInSamePageFlag: boolean
Read Only:
true
Indicates whether the report should open in the existing page or a new page. Valid values are Yes and No. The default value is Yes. -
OwnerName: string
Title:
Owner Name
Read Only:true
Person display name of task owner in case of single owner. Else, returns responsibility type name. -
OwnerPersonId: integer
(int64)
Title:
Owner Person ID
Read Only:true
Identifier of the task owner. Applicable only in case of a single task owner. -
OwnerType: string
Title:
Owner Type
Read Only:true
Maximum Length:30
Task owner type. -
OwnerTypeMeaning: string
Title:
Owner
Read Only:true
Task owner type meaning. -
ParentWorkerJourneyId: integer
(int64)
Title:
Worker Journey ID
Read Only:true
Unique identifier of the parent enterprise onboarding checklist. -
PerformerName: string
Title:
Performer Name
Read Only:true
Person display name of task performer in case of single performer. Else, returns responsibility type name. -
PerformerPersonId: integer
(int64)
Title:
Performer Person ID
Read Only:true
Person identifier of the task performer. Applicable only in case of a single task performer. -
PerformerType: string
Title:
Performer Type
Read Only:true
Task performer type. -
PerformerTypeMeaning: string
Title:
Performer
Read Only:true
Task performer type meaning. -
ReportPath: string
Title:
Report Path
Read Only:true
Maximum Length:1000
Path to the report in BI Catalog. -
RequiredFlag: boolean
Title:
Required
Read Only:true
Maximum Length:30
Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No. -
Sequence: integer
(int32)
Title:
Sequence
Read Only:true
Task display ordering sequence. Default is 1. -
SignAddress: string
Title:
IP Address of Signature
Read Only:true
Maximum Length:120
Internet protocol address where the electronic signature was provided. -
SignDate: string
(date)
Title:
Date of Signature
Read Only:true
Date on which the electronic signature was provided for an electronic signature task. -
SignerEmail: string
Title:
Email of Signer
Read Only:true
Maximum Length:400
Email address of the signer for an electronic signature task. -
SignerName: string
Title:
Name of Signer
Read Only:true
Maximum Length:120
Name of the signer for an electronic signature task. -
StageName: string
Read Only:
true
Name of the phase in a journey with multiple phases. -
StageSequence: integer
Read Only:
true
Sequence of the phase in a journey with multiple phases. -
Status: string
Title:
Status Code
Read Only:true
Maximum Length:60
Code for the task status. -
StatusCategory: string
Title:
Status Category
Read Only:true
Category of the status. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the task. -
SubType: string
Title:
Subtype Code
Read Only:true
Maximum Length:30
Task action subtype code. Available only for I 9 and Electronic Signature task types. -
SubTypeMeaning: string
Title:
Subtype
Read Only:true
Task action subtype. Available only for I 9 and Electronic Signature task types. -
TargetEndDate: string
(date)
Title:
Target End Date
Read Only:true
Due date of the task. -
TargetStartDate: string
(date)
Title:
Target Start Date
Read Only:true
Expected initiation date of the task. -
Type: string
Title:
Type Code
Read Only:true
Maximum Length:80
Code for the task action type. -
TypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
Meaning of the task type. -
WorkerJourneyTaskId: integer
(int64)
Title:
Journey Task ID
Read Only:true
Unique identifier of the journey task.
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.