Journeys
journeys Based on latest (2026.09)
Create, change, delete and look up Journeys, with all step tasks, contacts and events. Actions include contextual action label and default properties.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE8 actions
- Record key
JourneyId- Required on create
CategoryName- At a glance
- 73 fields3 finders11 children2 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/journeys?fields=AccessLevel,AccessLevelMeaning,AllocationControlCode,AllocationCriteria,AllocationCriteriaMeaning&limit=25&onlyData=true
{
"items": [
{
"AccessLevel": "<string, max 30>",
"AccessLevelMeaning": "<string, max 80>",
"AllocationControlCode": "ORA_NO_CONTROL",
"AllocationCriteria": "ORA_CHK_ALLOCATION_DT",
"AllocationCriteriaMeaning": "<string, max 80>"
}
],
"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 73
| Attribute | Type | Use |
|---|---|---|
AccessLevel | text · max 30 | Optional on createUpdatableSearchable |
AccessLevelMeaning | text · max 80 | Read-onlySearchable |
AllocationControlCode | text · max 30 · default ORA_NO_CONTROL | Read-only |
AllocationCriteria | text · max 30 · default ORA_CHK_ALLOCATION_DT | Optional on create |
AllocationCriteriaMeaning | text · max 80 | Read-onlySearchable |
AllocationOffsetDays | number · default 0 | Optional on create |
AllowAssignToDirectsFlag | yes/no | Read-only |
AllowAssignToListFlag | yes/no | Read-only |
AllowAssignToOrganizationFlag | yes/no | Read-only |
AllowAssignToPersonFlag | yes/no | Read-only |
AllowAssignToSelfFlag | yes/no | Read-only |
ArchiveOffsetDays | number | Optional on createUpdatable |
AssignedContentDescription | text | Optional on createUpdatable |
AssignedContentTitle | text | Optional on createUpdatable |
AssignedContentType | text · max 30 · default 20_ALERT_TEMPLATE | Optional on createUpdatableSearchable |
AssignedFeedFlag | yes/no | Read-only |
AssignedTemplateId | number | Optional on create |
BackgroundImage | text | Optional on createUpdatable |
BackgroundImageFileName | text · max 2048 | Optional on createUpdatable |
BackgroundImageSource | text | Read-only |
BackgroundImageURL | text · max 4000 | Optional on createUpdatable |
BackgroundThumbnailURL | text · max 4000 | Optional on createUpdatable |
Category | text · max 60 | Required on createUpdatableSearchable |
CategoryMeaning | text · max 120 | Read-only |
Code | text · max 240 | Read-onlySearchable |
CombinedNotificationTemplateId | number | Optional on create |
CompletedFeedFlag | yes/no | Read-only |
CompletionCriteria | text · max 30 · default ORA_CHK_MAND_TASK_COMPLETE | Optional on create |
CompletionCriteriaMeaning | text · max 80 | Read-onlySearchable |
CompletionMessage | text · max 720 | Optional on createUpdatable |
CompletionOffsetDays | number · default 0 | Optional on create |
Context | text · max 240 | Read-onlySearchable |
ContextualAction | text · max 240 | Read-onlySearchable |
Country | text · max 80 | Read-only |
CountryCode | text · max 30 | Optional on createSearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
CroppedBackgroundImage | text | Optional on createUpdatable |
DateFrom | date | Read-only |
DateTo | date | Read-only |
DeletedFeedFlag | yes/no | Read-only |
Description | text · max 360 | Optional on createUpdatable |
DisplayFeatures | text | Optional on create |
DisplayNameFormat | text · max 240 | Optional on createUpdatable |
DisplayType | text · max 30 | Optional on createUpdatableSearchable |
FavouriteFlag | yes/no · max 4 | Read-onlySearchable |
FeedFlag | yes/no | Read-only |
ForceCompletedContentDescription | text | Optional on createUpdatable |
ForceCompletedContentTitle | text | Optional on createUpdatable |
ForceCompletedContentType | text · max 30 · default 20_ALERT_TEMPLATE | Optional on createUpdatableSearchable |
ForceCompletedTemplateId | number | Optional on create |
InitiatedFeedFlag | yes/no | Read-only |
JourneyId | number | Read-onlySearchable |
JourneyTitle | text | Read-only |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
Level | text · max 30 · default ORA_PERSONAL | Read-onlySearchable |
LevelMeaning | text · max 80 | Read-onlySearchable |
LevelValue | number · default 0 | Read-onlySearchable |
MessageSubTitle | text · max 720 | Optional on createUpdatable |
MessageText | text · max 400 | Optional on createUpdatable |
MessageTitle | text · max 400 | Optional on createUpdatable |
Name | text · max 240 | Required on createUpdatableSearchable |
ObjectReferenceId | number | Optional on createUpdatableSearchable |
ProcessingMode | text · max 30 | Optional on create |
PurgeOffsetDays | number | Optional on createUpdatable |
RawBackgroundImageURL | text · max 4000 | Optional on createUpdatable |
RecurrentScheduleAllowedFlag | yes/no · max 4 · default false | Read-only |
Status | text · max 30 · default ORA_CHK_ACTIVE | Read-onlySearchable |
StatusMeaning | text · max 80 | Read-only |
SubCategory | text · max 60 | Optional on createSearchable |
SubCategoryMeaning | text · max 120 | Read-only |
SubjectType | text · max 240 · default P | Optional on createSearchable |
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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findAssignableContextualJourneys·ContextContextualActionSubjectAssignmentIdSubjectPersonIdfindAssignableJourneys·CategoryFilterCodeFilterExcludeGlobalExcludePersonalExcludeRecurringFacetsFilterAttributesLevelFilterSearchTermsSubCategoryFilterfindByWord·CategoryFilterExcludePersonalFilterAttributesSearchTerms
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 11
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/<name>. Add them to a GET with expand.
allStepTasksGET All Step Tasks · 40 fields · 1 findersActionURLAllowAttachmentFlagAllowCommentFlagAllowNoteTitleFlagAllowNotesContentFlagDelayDurationDelayDurationUOMDelayDurationUOMMeaningDependentTaskIdDependentTaskNameDescriptionGuidedJourneyCodeGuidedJourneyTaskCodesJourneyTaskIdNameNoteTitleNotesOpenInSamePageFlagOpenReportInSamePageFlagOwnerTypeOwnerTypeMeaningParentJourneyIdParentJourneyNamePerformerTypePerformerTypeMeaningQuestionnaireIdRequiredFlagSequenceStageIdStageNameStageSequenceStatusStatusMeaningSubTypeSubTypeMeaningTargetDurationTargetDurationUOMTargetDurationUOMMeaningTypeTypeMeaningcontactsGET · POST Contacts · 14 fieldsContactPersonIdContactUserCreatedByCreationDateCustomContactJourneyContactIdLastUpdateDateLastUpdatedByResponsibilityTypeResponsibilityTypeMeaningTitleTitleMeaningTypeTypeMeaningeventsGET · POST Events · 14 fieldsCategoryCategoryMeaningCreatedByCreationDateDescriptionEventDateEventOffsetEventURLImageURLJourneyEventIdLastUpdateDateLastUpdatedBySequenceTitlenotesGET · POST Notes · 14 fieldsCreatedByCreationDateDescriptionEventDateEventLocationEventOffsetEventTimeJourneyNoteIdLastUpdateDateLastUpdatedBySequenceTitleTypeTypeMeaningpropertiesGET · POST · PATCH Properties · 23 fieldsAssigneeDefaultValueAssigneeLookupTypeAssigneeValueCategoryCategoryMeaningCodeDisabledForAssigneeFlagDisabledForInitiatorFlagDisabledForLineManagerFlagDisabledForOthersFlagInitiatorDefaultValueInitiatorLookupTypeInitiatorValueLevelLineManagerDefaultValueLineManagerLookupTypeLineManagerValueNameOthersDefaultValueOthersLookupTypeOthersValueOverriddenFlagSequencetaskTypesGET · POST · PATCH Task Types · 7 fields · 1 findersCodeJourneyIdNameSubTypeSubTypeMeaningTypeTypeMeaningpropertiesGET · POST · PATCH Properties · 23 fields · 1 findersCategoryCategoryMeaningCodeDisabledForLineManagerFlagDisabledForOthersFlagDisabledForOwnerFlagDisabledForPerformerFlagLevelLineManagerDefaultValueLineManagerLookupTypeLineManagerValueNameOthersDefaultValueOthersLookupTypeOthersValueOverriddenFlagOwnerDefaultValueOwnerLookupTypeOwnerValuePerformerDefaultValuePerformerLookupTypePerformerValueSequencetasksGET · POST · PATCH · DELETE Tasks · 125 fields · 1 findersActionAddToCalendarLabelActionCompleteLabelActionRejectLabelActionSaveLabelActionURLActivationEligibilityProfileIdActivationEligibilityProfileNameActivityAction1LabelActivityAction2LabelActivityAction3LabelActivityAction4LabelActivityAction5LabelAddToLibraryFlagAgentCodeForCompletionAgentCodeForSaveAllowAttachmentFlagAllowCommentFlagAllowNoteTitleFlagAllowNotesContentFlagAnalysisParametersAnalysisPathAnalyticsSubTypeApplicationTaskApplicationTaskNameAttachmentDocumentTypeIdAttachmentDocumentTypeNameAttachmentTypeTagsCompletedFeedFlagConfigurableFormContextContactUserIdContactUserIdentifierContentProviderCodeCreatedByCreationDateDelayDurationDelayDurationUOMDelayDurationUOMMeaningDeletedFeedFlagDependentTaskCodeDependentTaskIdDependentTaskNameDescriptionDigitalSignatureTemplateIdDisplayFeaturesDisplayOptionsDocumentTypeIdDocumentTypeNameDocumentTypeTagsDynamicNotesSourceDynamicNotesTypeEligibilityProfileIdEligibilityProfileNameEmbeddedApplicationTaskCodeEmbeddedApplicationTaskTypeIdEnableExpiryFlagEvaluationOffsetExpiryDurationExpiryRelativeToExpiryRelativeToMeaningFeedFlagGuidedJourneyCodeGuidedJourneyTaskCodesInitiatedFeedFlagJourneyTaskIdLastUpdateDateLastUpdatedByLearnCommunityIdLearnEnrollmentIdLearnEnrollmentTypeLearningContentTypeLearningContentTypeMeaningLearningItemIdNameNoteTitleNotesOpenInSamePageFlagOpenReportInSamePageFlagOwnerPersonIdOwnerResponsibilityTypeOwnerResponsibilityTypeMeaningOwnerTypeOwnerTypeMeaningOwnerUserGroupCodePerformerPersonIdPerformerResponsibilityTypePerformerResponsibilityTypeMeaningPerformerTypePerformerTypeMeaningPerformerUserGroupCodeProcessCloudConfigurationQuestionnaireIdQuestionnaireNameReassignedFeedFlagReminderContentDescriptionReminderContentTitleReminderContentTypeReminderDurationReminderRecurrenceReminderRelativeToReminderRelativeToMeaningReminderTemplateIdReportPathRequiredFlagSaveAttachmentsToDORForSaveAttachmentsToDORForMeaningSaveDocumentsToDORForSaveDocumentsToDORForMeaningSequenceSignatureValidationConfigurationSourceTaskIdStatusStatusMeaningSubTypeSubTypeMeaningTargetDurationTargetDurationUOMTargetDurationUOMMeaningTaskCodeTaskGroupIdTypeTypeMeaningVideoTypeVideoTypeMeaningVideoURLWorkAuthorizationConfigurationdocumentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamenotificationsGET · POST · PATCH Notifications · 23 fieldsCreatedByCreationDateJourneyTaskNotificationIdLastUpdateDateLastUpdatedByNotifyOwnerFlagNotifyPerformerFlagOwnerContentDescriptionOwnerContentTitleOwnerContentTypeOwnerExpiryTemplateIdOwnerForceCompleteTemplateIdOwnerNotApplicableTemplateIdOwnerTemplateIdPerformerContentDescriptionPerformerContentTitlePerformerContentTypePerformerExpiryTemplateIdPerformerForceCompleteTemplateIdPerformerNotApplicableTemplateIdPerformerTemplateIdTaskEventTaskEventMeaningpropertiesGET · POST Journey Task Property · 23 fieldsCategoryCategoryMeaningCodeDisabledForLineManagerFlagDisabledForOthersFlagDisabledForOwnerFlagDisabledForPerformerFlagLevelLineManagerDefaultValueLineManagerLookupTypeLineManagerValueNameOthersDefaultValueOthersLookupTypeOthersValueOverriddenFlagOwnerDefaultValueOwnerLookupTypeOwnerValuePerformerDefaultValuePerformerLookupTypePerformerValueSequence
Actions 8
POST …/action/contextualActionLabel·ContextContextualActionPOST …/action/defaultPropertiesPOST …/action/defaultTaskTypeProperties·TypeSubTypePOST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQueryPOST …/action/findPopularJourneys·subCategorylimitcategorydisplayFieldsPOST …/action/uploadImage·parametersPOST …/{JourneyId}/action/duplicateJourney·journeyDetailsPOST …/{JourneyId}/action/toggleFavourite
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/journeysand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findAssignableContextualJourneysfor 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. - 36 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.