Worker Journeys
workerJourneys Based on latest (2026.09)
Create, change, delete and look up Worker Journeys, with all step tasks, contacts and events. Actions include assign contextual journey and assign journey.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE26 actions
- Record key
WorkerJourneyId- Required on create
CategoryNamePersonId- At a glance
- 77 fields6 finders18 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/workerJourneys?fields=AccessAssignmentId,AccessBasicInformation,AccessCompletedTasks,AccessContactSection,AccessDeferredTasks&limit=25&onlyData=true
{
"items": [
{
"AccessAssignmentId": "<string>",
"AccessBasicInformation": "<string>",
"AccessCompletedTasks": "<string>",
"AccessContactSection": "<string>",
"AccessDeferredTasks": "<string>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 77
| Attribute | Type | Use |
|---|---|---|
AccessAssignmentId | text | Read-only |
AccessBasicInformation | text | Read-only |
AccessCompletedTasks | text | Read-only |
AccessContactSection | text | Read-only |
AccessDeferredTasks | text | Read-only |
AccessEvents | text | Read-only |
AccessLevel | text · max 30 | Optional on createUpdatableSearchable |
AccessLevelMeaning | text · max 80 | Read-only |
AccessNotes | text | Read-only |
AccessOthersTasks | text | Read-only |
ActionAddTask | text | Read-only |
ActionAddTaskFromLibrary | text | Read-only |
ActionDate | date | Optional on createSearchable |
ActionEdit | text | Read-only |
ActionForceClose | text | Read-only |
ActionOccurrenceId | number | Read-only |
ActionRemove | text | Read-only |
AllocationDate | date | Optional on createSearchable |
AllowSaveAsTemplateFlag | yes/no | Optional on createUpdatable |
ArchiveOffsetDays | number | Optional on createUpdatable |
AssignedDate | date | Optional on create |
AssignedDateForSort | date | Read-only |
AssignedFeedFlag | yes/no | Optional on createUpdatable |
AssignmentId | number | Optional on create |
AssignmentName | text · max 255 | Read-only |
BackgroundImageSource | text | Read-only |
BackgroundImageURL | text · max 4000 | Read-onlySearchable |
BackgroundThumbnailURL | text · max 4000 | Read-only |
Category | text · max 60 | Required on createUpdatableSearchable |
CategoryMeaning | text · max 120 | Read-only |
Code | text · max 240 | Read-onlySearchable |
Comments | text · max 4000 | Optional on createUpdatable |
CompletedFeedFlag | yes/no | Optional on createUpdatable |
CompletionCriteria | text · max 30 | Optional on create |
CompletionCriteriaMeaning | text · max 80 | Read-only |
CompletionDate | date | Read-only |
CompletionMessage | text · max 720 | Read-only |
CompletionOffsetDays | number | Optional on create |
Context | text · max 240 | Optional on createUpdatableSearchable |
ContextualAction | text · max 240 | Read-onlySearchable |
Country | text · max 80 | Read-only |
CountryCode | text · max 30 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
DeletedFeedFlag | yes/no | Optional on createUpdatable |
Description | text · max 360 | Optional on createUpdatable |
DisplayName | text · max 240 | Read-only |
DisplayType | text · max 30 | Optional on createUpdatableSearchable |
FeedFlag | yes/no | Optional on createUpdatable |
InitiatedFeedFlag | yes/no | Optional on createUpdatable |
InitiatorDisplayName | text · max 240 | Read-onlySearchable |
InitiatorPersonId | number | Read-only |
Instance | text · max 20 | Optional on createUpdatableSearchable |
JourneyDisplayName | text | Optional on createUpdatable |
JourneyId | number | Read-onlySearchable |
JourneySubStatus | text · max 60 | Optional on createUpdatableSearchable |
JourneyTitle | text | Read-only |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
Level | text · max 30 | Optional on createUpdatableSearchable |
LevelMeaning | text · max 80 | Read-only |
LevelValue | number · default 0 | Optional on createUpdatableSearchable |
MessageSubTitle | text · max 720 | Optional on createUpdatable |
MessageText | text · max 400 | Read-only |
MessageTitle | text · max 400 | Optional on createUpdatable |
MultiPerformerEnabled | text · max 4 | Read-only |
Name | text · max 240 | Required on createUpdatableSearchable |
ObjectId | number · default -1 | Read-only |
ObjectReferenceId | number | Read-only |
PersonId | number | Required on createUpdatableSearchable |
PersonNumber | text · max 255 | Read-only |
PurgeOffsetDays | number | Optional on createUpdatable |
Status | text · max 60 | Optional on createSearchable |
StatusMeaning | text · max 80 | Read-only |
SubCategory | text · max 60 | Read-onlySearchable |
SubCategoryMeaning | text · max 120 | Read-only |
WorkerJourneyId | number | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 6
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findAllReportsJourneys·CategoryFilterFacetsSearchTermsStatusFilterSubCategoryFilterfindByJourneyId·AllocatedAfterDateJourneyIdOverdueStatusCategoryfindDirectReportsJourneys·CategoryFilterFacetsSearchTermsStatusFilterSubCategoryFilterfindOpenContextualJourneys·AssignmentIdContextContextualActionPersonIdfindOthersJourneys·CategoryFilterFacetsFilterAttributesPersonIdSearchTermsStatusFilterSubCategoryFilterfindSelfJourneys·CategoryFilterCodeFilterFacetsSearchTermsStatusFilterSubCategoryFilter
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 18
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/<name>. Add them to a GET with expand.
allStepTasksGET All Step Tasks · 77 fields · 12 findersAccessActivityAccessAttachmentsAccessCommentsAccessContactAccessGuidedJourneyAccessNotesActionCompleteActionEditActionEditDueDateActionReassignActionRejectActionRemoveActionReopenActionSendReminderActionURLActualEndDateActualStartDateAllowAttachmentFlagAllowCommentFlagAllowMultipleCommentsFlagAllowNoteTitleFlagAllowNotesContentFlagAllowPrecedingTaskFlagAnalysisPathAnalyticsSubTypeApplicationTaskNameCommentsCompletedByDisplayNameCompletedByPersonIdCompletionDateConfigurableFormContextContentProviderCodeDeferredStartDateDependentTaskIdDependentTaskNameDescriptionEmbeddedApplicationTaskCodeExpiryRelativeToGuidedJourneyCodeGuidedJourneyTaskCodesNameNoteTitleNotesOpenInSamePageFlagOpenReportInSamePageFlagOwnerNameOwnerPersonIdOwnerTypeOwnerTypeMeaningParentWorkerJourneyIdPerformerNamePerformerPersonIdPerformerTypePerformerTypeMeaningReportPathRequiredFlagSequenceSignAddressSignDateSignerEmailSignerNameStageNameStageSequenceStatusStatusCategoryStatusMeaningSubSequenceSubTypeSubTypeMeaningTargetDurationTargetDurationUOMTargetEndDateTargetStartDateTaskEntityIdTypeTypeMeaningWorkerJourneyTaskIdcontactsGET Contacts · 9 fieldsContactEmailContactNameContactPersonIdContactPersonNumberTitleTitleMeaningTypeTypeMeaningWorkerJourneyContactIdeventsGET Events · 8 fieldsCategoryCategoryMeaningDescriptionEventURLImageURLSequenceTitleWorkerJourneyEventIdnotesGET Notes · 9 fieldsDescriptionEventDateEventLocationEventTimeSequenceTitleTypeTypeMeaningWorkerJourneyNoteIdpropertiesGET · POST · PATCH Properties · 22 fieldsAssigneeDefaultValueAssigneeLookupTypeAssigneeValueCategoryCategoryMeaningCodeDisabledForAssigneeFlagDisabledForInitiatorFlagDisabledForLineManagerFlagDisabledForOthersFlagInitiatorDefaultValueInitiatorLookupTypeInitiatorValueLevelLineManagerDefaultValueLineManagerLookupTypeLineManagerValueNameOthersDefaultValueOthersLookupTypeOthersValueOverriddenFlagtaskCountsGET Task Counts · 13 fieldsAvailableOthersTasksAvailableSelfTasksCompletedOthersTasksCompletedSelfTasksCompletedTasksCompletedWorkerTasksOthersTasksOverdueSelfTasksOverdueTasksSelfTasksTasksWorkerJourneyIdWorkerTaskstaskTypesGET · POST · PATCH Task Types · 7 fields · 1 findersCodeNameSubTypeSubTypeMeaningTypeTypeMeaningWorkerJourneyIdpropertiesGET · POST · PATCH Properties · 23 fields · 1 findersCategoryCategoryMeaningCodeDisabledForLineManagerFlagDisabledForOthersFlagDisabledForOwnerFlagDisabledForPerformerFlagLevelLineManagerDefaultValueLineManagerLookupTypeLineManagerValueNameOthersDefaultValueOthersLookupTypeOthersValueOverriddenFlagOwnerDefaultValueOwnerLookupTypeOwnerValuePerformerDefaultValuePerformerLookupTypePerformerValueSequencetasksGET · POST · PATCH · DELETE Tasks · 158 fields · 5 findersAccessActivityAccessAttachmentsAccessCommentsAccessContactAccessGuidedJourneyAccessNotesActionAddToCalendarActionAddToCalendarLabelActionCompleteActionCompleteLabelActionEditActionEditDueDateActionReassignActionRejectActionRejectLabelActionRemoveActionReopenActionRevertActionSaveActionSaveLabelActionSendReminderActionURLActivityAction1LabelActivityAction2LabelActivityAction3LabelActivityAction4LabelActivityAction5LabelActualEndDateActualStartDateAddAttachmentsToDORFlagAddToCalendarAddToLibraryFlagAdvisorCodeAgentCodeForCompletionAgentCodeForSaveAllowAttachmentFlagAllowCommentFlagAllowMultipleCommentsFlagAllowNoteTitleFlagAllowNotesContentFlagAnalysisParametersAnalysisPathAnalyticsSubTypeApplicationTaskNameAttachmentDocumentTypeIdAttachmentDocumentTypeNameAttachmentTypeTagsAuthenticationFormatAuthenticationInstructionTextCommentsCompletedByDisplayNameCompletedByPersonIdCompletedFeedFlagCompletionDateConfigurableFormContextContentProviderCodeCreatedByCreationDateDeferredStartDateDelayDurationRelativeToDeletedFeedFlagDependentTaskIdDependentTaskNameDescriptionDisplayOptionsDocumentTypeIdDocumentTypeNameDocumentTypeTagsDynamicNotesSourceDynamicNotesTypeEmbeddedApplicationTaskCodeEmbeddedApplicationTaskTypeIdEnableEmailFlagEnableExpiryFlagEnableSignatureFlagErrorDetailsErrorMessageErrorTypeExpiryDateExpiryDurationExpiryRelativeToExpiryRelativeToMeaningFeedFlagGuidedJourneyCodeGuidedJourneyTaskCodesInitiatedFeedFlagJourneyTaskIdLastUpdateDateLastUpdatedByLearnCommunityIdLearnEnrollmentIdLearnEnrollmentTypeLearningContentTypeLearningContentTypeMeaningLearningItemIdNameNoteTitleNotesOpenInSamePageFlagOpenReportInSamePageFlagOwnerNameOwnerPersonIdOwnerTypeOwnerTypeMeaningOwnerWorkEmailAddressParentJourneyIdPerformerNamePerformerPersonIdPerformerTypePerformerTypeMeaningProcessingModeQuestionnaireIdQuestionnaireNameReassignedFeedFlagReminderDurationReminderRecurrenceReminderRelativeToReminderRelativeToMeaningReportPathRequiredFlagSaveAttachmentsToDORForSaveAttachmentsToDORForMeaningSaveDocumentsToDORForSaveDocumentsToDORForMeaningSequenceSignAddressSignDateSignatureImageDataSignatureNameValidationSignatureValidationModeSignerAuthenticationSignerEmailSignerNameStageJourneyIdStatusStatusCategoryStatusMeaningSubSequenceSubTypeSubTypeMeaningTargetDurationTargetDurationRelativeToTargetDurationUOMTargetDurationUOMMeaningTargetEndDateTargetStartDateTaskCompletionEnabledFlagTaskEntityIdTypeTypeMeaningVideoTypeVideoTypeMeaningVideoURLWorkAuthorizationProgressStatusWorkAuthorizationProgressStatusMeaningWorkAuthorizationVerificationStatusWorkAuthorizationVerificationStatusMeaningWorkerJourneyTaskIdattachmentsGET · POST · PATCH · DELETE Candidate Attachments · 33 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamedocumentsGET · POST · PATCH · DELETE Candidate Attachments · 33 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamelearningItemsGET Learning Content Items List of Values · 16 fields · 1 finderselearnCoverArtLinkelearnDisableReassignObserverChecklistToAnyoneelearnDisableSelfAssessChecklistelearnObserverTypeelearnObserverTypeMeaningelearnRichMediaLinkelearnRouteUsingelearnRouteUsingMeaningelearnTimePERAttemptelearnTimePERAttemptUnitselearnTypeelearnTypeMeaninglearningItemDescriptionlearningItemIdlearningItemNumberlearningItemTitlenotificationsGET · POST · PATCH Notifications · 9 fieldsCreatedByCreationDateLastUpdateDateLastUpdatedByNotifyOwnerFlagNotifyPerformerFlagTaskEventTaskEventMeaningWorkerJourneyTaskNotificationIdpropertiesGET · POST · PATCH Journey Task Properties · 23 fieldsCategoryCategoryMeaningCodeDisabledForLineManagerFlagDisabledForOthersFlagDisabledForOwnerFlagDisabledForPerformerFlagLevelLineManagerDefaultValueLineManagerLookupTypeLineManagerValueNameOthersDefaultValueOthersLookupTypeOthersValueOverriddenFlagOwnerDefaultValueOwnerLookupTypeOwnerValuePerformerDefaultValuePerformerLookupTypePerformerValueSequencequestionnaireResponsesGET · POST · PATCH Questionnaire Responses · 13 fieldsAttemptNumberCreatedByCreationDateLastUpdateDateLastUpdatedByLatestAttemptFlagQuestionnaireParticipantIdQuestionnaireResponseIdQuestionnaireVersionNumberStatusStatusMeaningSubmittedDateTimeTotalScorequestionResponsesGET · POST · PATCH Question Responses · 21 fieldsAnswerCodeAnswerCodeListAnswerCommentsAnswerLargeObjectAnswerListAnswerShortDescriptionListAnswerShortdescriptionChoiceCodeListChoiceListChoiceShortDescriptionCreatedByCreationDateLastUpdateDateLastUpdatedByQuestionAnswerIdQuestionCodeQuestionIdQuestionResponseIdQuestionTextQuestionnaireQuestionIdScorequestionResponseAttachmentsGET · POST · PATCH · DELETE Question Response Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNametasksDFFGET · POST · PATCH · DELETE Allocated Checklist Task Attributes · 3 fieldsAllocatedTaskId__FLEX_Context__FLEX_Context_DisplayValue
Actions 26
POST …/action/assignContextualJourney·PersonIdAssignmentIdAllocationDateTemplateIdPOST …/action/assignJourney·PersonNumberDescriptionTemplateCountryCommentsAsyncFlagPersonIdTemplateCategoryAssignmentIdAssignmentNumberAllocationDateTemplateNameTaskExclusionsTemplateIdPOST …/action/findOrAssignContextualJourney·ContextPersonIdAssignmentIdAllocationDateContextualActionJourneyFlowPOST …/action/getJourneyAllocationDetails·ChecklistActionOccurrenceIdPOST …/action/synchronizeToOsByPerson·parametersPOST …/action/uploadImage·parametersPOST …/{WorkerJourneyId}/action/addTaskFromLibrary·LibraryTaskNameLibraryTaskIdPerformerPersonIdAllocationDatePerformerPersonNumberPOST …/{WorkerJourneyId}/action/compareWithOSCS·parametersPOST …/{WorkerJourneyId}/action/exportLogsPOST …/{WorkerJourneyId}/action/fetchJourneyFromOSCSPOST …/{WorkerJourneyId}/action/forceCompletePOST …/{WorkerJourneyId}/action/synchronizeToOsPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/checkTaskCompletion·subTypetypePOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/copyToDocumentRecordsPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateContent·ContextPersonIdAssignmentIdPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateDynamicNotes·parametersPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationDetails·parametersPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationURL·SectionTypeSignAddressSignerNameReturnURLSignerEmailPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/invokeProcessAutomationPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/reassign·PerformerPersonIdPerformerPersonNumberPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/reassignByPerformerType·PerformerTypeparametersPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/reopen·parametersPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/sendReminderPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/updateStatus·payloadPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/updateTaskStage·payloadPOST …/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/uploadImage·parameters
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/workerJourneysand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findAllReportsJourneysfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AccessLevel, notaccesslevel. - 46 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.