1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Worker Journeys

Get all worker journeys

get

/hcmRestApi/resources/11.13.18.05/workerJourneys

Request

Query Parameters
  • 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 journeys that match the primary key specified.
      Finder Variables
      • WorkerJourneyId; integer; Unique identifier of the journey.
    • findAllReportsJourneys Finds all journeys assigned to all reports of the current signed in user and restricted by the person security profile.
      Finder Variables
      • CategoryFilter; string; Attribute to filter journeys assigned to all reports of the current signed in user by category.
      • Facets; string; Facet names to group search results for journeys assigned to all reports of the current signed in user.
      • SearchTerms; string; Search criteria to find journeys assigned to all reports of the current signed in user.
      • StatusFilter; string; Attribute to filter journeys assigned to all reports of the current signed in user by status.
      • SubCategoryFilter; string; Filter attribute to retrieve journeys assigned to all reports of the current signed in user by subcategory.
    • findByJourneyId Finds all the journeys based on the journey identifier.
      Finder Variables
      • AllocatedAfterDate; string; Filter attribute to retrieve journeys that are assigned after a specific date.
      • JourneyId; integer; Filter attribute to retrieve journeys based on the journey identifier.
      • Overdue; string; Filter attribute to retrieve journeys that are overdue.
      • StatusCategory; string; Filter attribute to retrieve journeys based on the status category.
    • findDirectReportsJourneys Finds all journeys assigned to direct reports of the current signed in user and restricted by the person security profile.
      Finder Variables
      • CategoryFilter; string; Attribute to filter journeys assigned to direct reports of the current signed in user by category.
      • Facets; string; Facet names to group search results for journeys assigned to direct reports of the current signed in user.
      • SearchTerms; string; Search criteria to find journeys assigned to direct reports of the current signed in user.
      • StatusFilter; string; Attribute to filter journeys assigned to direct reports of the current signed in user by status.
      • SubCategoryFilter; string; Filter attribute to retrieve journeys assigned to direct reports of the current signed in user by subcategory.
    • findOpenContextualJourneys Finds all open contextual journeys.
      Finder Variables
      • AssignmentId; integer; Filter attribute to retrieve contextual journeys based on assignment identifier.
      • Context; string; Filter attribute to retrieve contextual journeys based on context.
      • ContextualAction; string; Filter attribute to retrieve contextual journeys based on the transaction flow.
      • PersonId; integer; Filter attribute to retrieve contextual journeys based on person identifier.
    • findOthersJourneys Finds all journeys assigned to workers other than the current signed in user and restricted by the person security profile.
      Finder Variables
      • CategoryFilter; string; Attribute to filter journeys assigned to workers other than the current signed in user by category.
      • Facets; string; Facet names to group search results for journeys assigned to workers other than the current signed in user.
      • FilterAttributes; string; Filter attribute to retrieve journeys assigned to workers other than the current signed in user.
      • PersonId; integer; Attribute to filter journeys assigned to workers other than the current signed in user by person identifier.
      • SearchTerms; string; Search criteria to find journeys assigned to workers other than the current signed in user.
      • StatusFilter; string; Attribute to filter journeys assigned to workers other than the current signed in user by status.
      • SubCategoryFilter; string; Filter attribute to retrieve journeys assigned to workers other than the current signed in user by subcategory.
    • findSelfJourneys Finds all journeys assigned to the signed in user.
      Finder Variables
      • CategoryFilter; string; Attribute to filter journeys assigned to the current signed in user by category.
      • CodeFilter; string; Filter attribute to retrieve journeys assigned to the current signed in user by code.
      • Facets; string; Facet names to group search results for journeys assigned to the current signed in user.
      • SearchTerms; string; Search criteria to find journeys assigned the current signed in user.
      • StatusFilter; string; Attribute to filter journeys assigned to the current signed in user by status.
      • SubCategoryFilter; string; Filter attribute to retrieve journeys assigned to the current signed in user by subcategory.
  • 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:
    • ActionDate; string; Date as of which the journey is allocated.
    • AllocationDate; string; Date on which the journey is initiated.
    • BackgroundImageURL; string; URL of the image displayed on the journey card and journey details page.
    • Category; string; Category code of the journey.
    • Context; string; Context for a journey.
    • ContextualAction; string; Transaction flow for which the contextual journey is applicable.
    • CountryCode; string; Code of the country to which the journey is applicable.
    • InitiatorDisplayName; string; Display name of the journey initiator.
    • Instance; string; Instance of the allocated journey to identify if the same journey is allocated to the worker multiple times.
    • JourneyId; integer; Identifier of the journey.
    • Name; string; Name of the journey.
    • PersonId; integer; Internal identifier of the journey assignee.
    • Status; string; Status code of the worker journey.
    • SubCategory; string; Subcategory of the worker journey.
    • WorkerJourneyId; integer; Primary key generated by the application.
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workerJourneys-item-response
Type: object
Show Source
Nested Schema : All Step Tasks
Type: array
Title: All Step Tasks
The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.
Show Source
Nested Schema : Contacts
Type: array
Title: Contacts
The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.
Show Source
Nested Schema : Events
Type: array
Title: Events
The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.
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 : Task Counts
Type: array
Title: Task Counts
The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.
Show Source
Nested Schema : Tasks
Type: array
Title: Tasks
The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.
Show Source
Nested Schema : Task Types
Type: array
Title: Task Types
The taskTypes resource is the child of the workerJourneys resource. It includes all the task types associated with the parent journey template.
Show Source
Nested Schema : workerJourneys-allStepTasks-item-response
Type: object
Show Source
Nested Schema : workerJourneys-contacts-item-response
Type: object
Show Source
  • Title: Contact Email
    Read Only: true
    Work email of the contact.
  • Title: Contact Name
    Read Only: true
    Person name of the contact.
  • Title: Contact Person ID
    Read Only: true
    Internal identifier for the contact.
  • Title: Person Number
    Read Only: true
    Person number of the contact.
  • Links
  • Title: Contact Title
    Read Only: true
    Maximum Length: 30
    Title of the contact. Values are from the ORA_PER_ONB_CONTACT_TITLE lookup. For example, ONBOARDING_SPONSOR
  • Title: Contact Meaning
    Read Only: true
    Maximum Length: 80
    Meaning of the contact title. For example, Onboarding Sponsor.
  • Title: Contact Type
    Read Only: true
    Maximum Length: 30
    Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. For example, Line Manager, Area of Responsibility.
  • Title: Contact Meaning
    Read Only: true
    Maximum Length: 80
    Meaning of the contact type.
  • Title: Contact ID
    Read Only: true
    Unique identifier of the journey contact.
Nested Schema : workerJourneys-events-item-response
Type: object
Show Source
Nested Schema : workerJourneys-notes-item-response
Type: object
Show Source
Nested Schema : workerJourneys-properties-item-response
Type: object
Show Source
Nested Schema : workerJourneys-taskCounts-item-response
Type: object
Show Source
  • Read Only: true
    Count of tasks in the journey that are active and aren't deferred for users other than the signed in user.
  • Title: Active Tasks for Self
    Read Only: true
    Count of tasks in the journey that are active and aren't deferred for the signed in user.
  • Title: Others Completed Tasks
    Read Only: true
    Count of tasks to be completed by users other than the signed in user or the journey assignee in the journey.
  • Title: Completed Tasks for Self
    Read Only: true
    Count of tasks completed by the signed in user in the journey.
  • Title: Total Completed Tasks
    Read Only: true
    Total number of completed tasks in the journey.
  • Title: Completed Tasks for Assignee
    Read Only: true
    Count of tasks completed by journey assignee in the journey.
  • Links
  • Title: Others Tasks
    Read Only: true
    Count of tasks to be performed by users other than the signed in user or the journey assignee in the journey.
  • Title: Overdue Tasks for Self
    Read Only: true
    Count of overdue tasks for the signed in user in the journey.
  • Title: Total Overdue Tasks
    Read Only: true
    Total number of overdue tasks in the journey.
  • Title: Tasks for Self
    Read Only: true
    Count of tasks for the signed in user in the journey.
  • Title: Total Tasks
    Read Only: true
    Total tasks in the journey.
  • Title: Worker Journey ID
    Read Only: true
    Unique identifier of the journey.
  • Title: Assignee Tasks
    Read Only: true
    Count of assignee tasks in the journey.
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
Nested Schema : workerJourneys-taskTypes-item-response
Type: object
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 : workerJourneys-taskTypes-properties-item-response
Type: object
Show Source
Links
assignContextualJourney
Assigns a contextual journey to a worker.
assignJourney
Allocates a journey to a worker.
findOrAssignContextualJourney
Finds existing contextual journeys for a worker.
getJourneyAllocationDetails
Get journey allocation status details for a worker.
Back to Top