Get all tasks

get

/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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 worker journey tasks that match the primary key specified.
      Finder Variables
      • WorkerJourneyTaskId; integer; Unique identifier of the journey task.
    • findActivePhases Finds all active journey phases.
      Finder Variables
      • findAvailableSelfTasks Finds all journey tasks except deferred tasks for the signed in user.
        Finder Variables
        • findOthersTasks Finds all journey tasks for users other than the signed in user and journey assignee.
          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
            • 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.
            • 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
            • 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.
            • The resource item payload will be filtered in order to contain only data (no links section, for example).
            • 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
            • 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:
              • AuthenticationFormat; string; Password authentication format for an electronic signature task.
              • JourneyTaskId; integer; Identifier of the journey task.
              • LearningContentTypeMeaning; string; Meaning of the learning content type.
              • Name; string; Name of the journey task.
              • PerformerPersonId; integer; Person identifier of the task performer. Available only in case of single performer, is updatable when adding a new task.
              • RequiredFlag; boolean; Indicates whether the task is mandatory or optional. Valid values are Yes and No. The default value is No.
              • SaveAttachmentsToDORForMeaning; string; Meaning of save attachments to document records.
              • Status; string; Status code of the task.
              • TargetDurationUOMMeaning; string; Meaning of unit of measure used in the task target duration.
              • VideoTypeMeaning; string; Meaning of video type.
              • WorkerJourneyTaskId; integer; Unique identifier of the journey task.
            • 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
            • 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".
            • 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 Top

            Response

            Supported Media Types

            Default Response

            The following table describes the default response for this task.
            Headers
            • 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".
            • 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.
            Body ()
            Root Schema : workerJourneys-tasks
            Type: object
            Show Source
            Nested Schema : Items
            Type: array
            Title: Items
            The items in the collection.
            Show Source
            Nested Schema : workerJourneys-tasks-item-response
            Type: object
            Show Source
            Nested Schema : Attachments
            Type: array
            Title: Attachments
            The attachments resource is used to view, create, and update attachments.
            Show Source
            Nested Schema : Attachments
            Type: array
            Title: Attachments
            The attachments resource is used to view, create, and update attachments.
            Show Source
            Nested Schema : Learning Content Items List of Values
            Type: array
            Title: Learning Content Items List of Values
            The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.
            Show Source
            Nested Schema : Notifications
            Type: array
            Title: Notifications
            The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.
            Show Source
            Nested Schema : Journey Task Properties
            Type: array
            Title: Journey Task Properties
            The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.
            Show Source
            Nested Schema : Questionnaire Responses
            Type: array
            Title: Questionnaire Responses
            The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
            Show Source
            Nested Schema : tasksDFF
            Type: array
            Show Source
            Nested Schema : workerJourneys-tasks-attachments-item-response
            Type: object
            Show Source
            Nested Schema : workerJourneys-tasks-documents-item-response
            Type: object
            Show Source
            Nested Schema : workerJourneys-tasks-learningItems-item-response
            Type: object
            Show Source
            • Title: eLearning Disable Reassignment of the Observer Checklist to Anyone
              Read Only: true
              Maximum Length: 1
              Indicates whether the reassignment of the observer checklist to any user who isn't a configured observer, as defined on the learning item, is disabled. Valid values are Y, N for the observation checklist e-learn type. Default value is Y.
            • Title: eLearning Disable Self-Assessment Checklist
              Read Only: true
              Maximum Length: 1
              Indicates whether the self-assessment checklist for the observation checklist is disabled. Valid values are Y, N for the observation checklist elearnType. Default value is Y.
            • Title: eLearning Observer Type
              Read Only: true
              Maximum Length: 30
              Type of observer for the observation checklist e-learn type such as Individuals or Representative. Valid values are defined in the list ELearnObserverTypeLOV.
            • Title: eLearning Observer Type Description
              Read Only: true
              Maximum Length: 80
              Description of the e-learn observer type.
            • Title: eLearning Route Using
              Read Only: true
              Maximum Length: 30
              Approval routes for the observation checklist e-learn type. Valid values are defined in the list ELearnRouteUsingLOV.
            • Title: eLearning Route Using Description
              Read Only: true
              Maximum Length: 80
              Description of the elearnRouteUsing.
            • Title: eLearning Time per Attempt
              Read Only: true
              Time limit per attempt on the learning content item.
            • Title: eLearning Time per Attempt Units
              Read Only: true
              Maximum Length: 30
              Units for time limit per attempt on the learning content item such as Hour, or Minute. Valid values are defined in the list ELearnTimePerAttemptUnitsLOV.
            • Title: Content Type
              Read Only: true
              Maximum Length: 30
              Type of self-paced learning such as Video or SCORM. Valid values are defined in the list ContentTypeLOV.
            • Title: Content Type Description
              Read Only: true
              Description of the e-learn type.
            • Title: Description
              Read Only: true
              Maximum Length: 4000
              Description of the learning item.
            • Title: Content Catalog Learning Item ID
              Read Only: true
              Unique identifier for the learning content item which is the internal primary key.
            • Title: Content Number
              Read Only: true
              Maximum Length: 30
              User-friendly number identifying the learning content item. It's a surrogate key which is shown in the UI.
            • Title: Content Title
              Read Only: true
              Maximum Length: 250
              Title of the learning content item.
            • Links
            Nested Schema : workerJourneys-tasks-notifications-item-response
            Type: object
            Show Source
            Nested Schema : workerJourneys-tasks-properties-item-response
            Type: object
            Show Source
            Nested Schema : workerJourneys-tasks-questionnaireResponses-item-response
            Type: object
            Show Source
            Nested Schema : Question Responses
            Type: array
            Title: Question Responses
            The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
            Show Source
            Nested Schema : workerJourneys-tasks-questionnaireResponses-questionResponses-item-response
            Type: object
            Show Source
            • Title: Answer Code
              Read Only: true
              Maximum Length: 240
              The answer code that a participant chose when responding to a single choice question.
            • Title: Answer Code List
              Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
            • Title: Comments
              Maximum Length: 4000
              Additional comments provided by the participant when responding to a question.
            • Title: Answer
              Attachment provided by the participant when responding to a question.
            • Title: Answer List
              Maximum Length: 2000
              Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
            • Title: Answer Short Description
              Read Only: true
              Maximum Length: 240
              Text of the answer chosen by a participant when responding to a single choice question.
            • Title: Answer Short Description
              Read Only: true
              Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
            • Title: Choice List Code
              Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
            • Title: Choice List
              Maximum Length: 2000
              Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
            • Title: Choice Short Description
              Read Only: true
              Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
            • Title: Created By
              Read Only: true
              Maximum Length: 64
              User who created the question response.
            • Title: Creation Date
              Read Only: true
              Date on which the question response was created.
            • Title: Last Update Date
              Read Only: true
              Date on which the question response was updated.
            • Title: Last Updated By
              Read Only: true
              Maximum Length: 64
              User who last updated the question response.
            • Links
            • Title: Question Answer Id
              Surrogate identifier of the answer that a participant chose when responding to a single choice question.
            • Title: Question Code
              Maximum Length: 240
              Alphanumeric value that uniquely identifies a question defined for a subscriber.
            • Title: Question Id
              Surrogate identifier for the question.
            • Title: Questionnaire Question Id
              Surrogate identifier for the question in a questionnaire.
            • Question Response Attachments
              Title: Question Response Attachments
              The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
            • Title: Question Response Id
              Surrogate identifier for the question response.
            • Title: Question Text
              Read Only: true
              Maximum Length: 2000
              Text of the question that a participant responds to.
            • Title: Answer Score
              Read Only: true
              Calculated score for the responses provided for a question by a participant.
            Nested Schema : Question Response Attachments
            Type: array
            Title: Question Response Attachments
            The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
            Show Source
            Nested Schema : workerJourneys-tasks-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
            Type: object
            Show Source
            Nested Schema : workerJourneys-tasks-tasksDFF-item-response
            Type: object
            Show Source
            Back to Top