Orchestrations
orchestrations Based on latest (2026.09)
Create, change, delete and look up Orchestrations, with error logs and stages. Actions include clone orchestration.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
OrchestrationNumber- Required on create
ObjectCodeOrchestrationNameOrchestrationTypeStatusCode- At a glance
- 28 fields3 finders8 children2 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/orchestrations?fields=ActivationDateTime,ActivityRelationshipAttrName,AssociationCriteriaExpression,AssociationRank,CreatedBy&limit=25&onlyData=true
{
"items": [
{
"ActivationDateTime": "2026-01-31T09:00:00+00:00",
"ActivityRelationshipAttrName": "<string, max 100>",
"AssociationCriteriaExpression": "<string>",
"AssociationRank": 0,
"CreatedBy": "<string, max 64>"
}
],
"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 28
| Attribute | Type | Use |
|---|---|---|
ActivationDateTime | date-time | Optional on createUpdatableSearchable |
ActivityRelationshipAttrName | text · max 100 | Optional on createUpdatable |
AssociationCriteriaExpression | text | Optional on createUpdatable |
AssociationRank | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CreationMethod | text · max 80 | Optional on createUpdatableSearchable |
DeleteFlag | yes/no | Read-onlySearchable |
ImportedDateTime | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-only |
LifecycleAttributeDisplayLabel | text · max 1000 | Optional on create |
LifecycleAttributeName | text · max 100 | Optional on create |
ObjectCode | text · max 100 | Required on createUpdatableSearchable |
OrchestrationDescription | text · max 2000 | Optional on createUpdatable |
OrchestrationId | number | Optional on createSearchable |
OrchestrationName | text · max 100 | Required on createUpdatableSearchable |
OrchestrationNumber | text · max 64 | Optional on createSearchable |
OrchestrationType | text · max 30 | Required on createSearchable |
PerformAction | text · max 100 | Optional on createUpdatable |
SimulationCriteriaExpression | text | Optional on createUpdatable |
SourceOrchestrationId | number | Optional on createUpdatable |
StatusCode | text · max 30 | Required on createUpdatableSearchable |
StripingAttributeDisplayLabel | text · max 1000 | Optional on create |
StripingAttributeName | text · max 100 | Optional on create |
StripingAttributeValue | text · max 2000 | Optional on create |
SyncStagesRequiredFlag | yes/no · max 1 | Read-only |
UpdateFlag | yes/no | 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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
OrchCsmExportImportAltKey·LifecycleAttributeNameObjectCodeOrchestrationNumberStripingAttributeNameOrchExportImportAltKey·LifecycleAttributeNameObjectCodeOrchestrationNameOrchestrationNumberStripingAttributeNameOrchestrationNumberAltKey·OrchestrationNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 8
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/<name>. Add them to a GET with expand.
ErrorLogsGET Error Logs · 20 fields · 1 findersCreatedByCreationDateErrorDescriptionErrorLogsIdErrorLogsNumberErrorTextLastUpdateDateLastUpdatedByOrchestrationAssociationIdOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberSourceObjectCodeSourceObjectIdStagesGET · POST · PATCH · DELETE Stages · 13 fields · 1 findersContainErrorsFlagCreatedByCreationDateDisplaySequenceLastUpdateDateLastUpdatedByOrchestrationIdOrchestrationNameOrchestrationNumberOrchestrationStageIdOrchestrationStageNumberStageDescriptionStageNameStageObjectivesGET · POST · PATCH · DELETE Stage Objectives · 13 fields · 1 findersCreatedByCreationDateDisplaySequenceLastUpdateDateLastUpdatedByObjectiveDescriptionObjectiveNameObjectiveStatusOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberStageObjectiveIdStageObjectiveNumberStepObjectivesAssociationsGET · POST · PATCH · DELETE Step Objective Associations · 15 fields · 1 findersCreatedByCreationDateLastUpdateDateLastUpdatedByOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStageObjectiveIdOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberStageObjectiveNameStageObjectiveNumberStepObjectiveAssocIdStepObjectiveAssocNumberStepTasksGET · POST · PATCH · DELETE Step Tasks · 29 fields · 1 findersActivityIdActivityTemplateIdAllowSkipFlagAssignedToAssignedToRuleCreatedByCreationDateDisplaySequenceEmailTemplateIdEvaluateOnMarkCompleteFlagFieldUpdateJsonGracePeriodIATemplateNameIATemplateValueLastUpdateDateLastUpdatedByOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberOrchestrationStepTaskDescriptionOrchestrationStepTaskNameSMARTActionIdStepTasksIdStepTasksNumberStepTemplateIdWaitForRepliesFlagStepsGET · POST · PATCH · DELETE Steps · 40 fields · 1 findersActivityTemplateIdAllowSkipFlagCreatedByCreationDateDaysToWaitDisplaySequenceEmailContactsFilterCriteriaEmailContsObjectCdEmailTemplateIdEvaluateOnMarkCompleteFlagExecutionMethodExitOrchestrationFlagFailureStepIdFailureStepNameFailureStepNumberFieldUpdateJsonGracePeriodHoursToWaitIATemplateValueLastUpdateDateLastUpdatedByNextStageValueOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberPreStepConditionSMARTActionIdStepSuggestionTextStepTemplateIdStepTemplateNameStepTemplateStepNameStepTypeSuccessCriteriaSuccessStepIdSuccessStepNameSuccessStepNumberWaitForRepliesFlagStepObjectivesAssociationsGET · POST · PATCH · DELETE Step Objective Associations · 15 fields · 1 findersCreatedByCreationDateLastUpdateDateLastUpdatedByOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStageObjectiveIdOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberStageObjectiveNameStageObjectiveNumberStepObjectiveAssocIdStepObjectiveAssocNumberStepTasksGET · POST · PATCH · DELETE Step Tasks · 29 fields · 1 findersActivityIdActivityTemplateIdAllowSkipFlagAssignedToAssignedToRuleCreatedByCreationDateDisplaySequenceEmailTemplateIdEvaluateOnMarkCompleteFlagFieldUpdateJsonGracePeriodIATemplateNameIATemplateValueLastUpdateDateLastUpdatedByOrchestrationStageIdOrchestrationStageNameOrchestrationStageNumberOrchestrationStepIdOrchestrationStepNameOrchestrationStepNumberOrchestrationStepTaskDescriptionOrchestrationStepTaskNameSMARTActionIdStepTasksIdStepTasksNumberStepTemplateIdWaitForRepliesFlag
Actions 1
POST …/action/cloneOrchestration·newOrchestrationNamesourceOrchestrationId
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
/crmRestApi/resources/11.13.18.05/orchestrationsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
OrchCsmExportImportAltKeyfor 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:ActivationDateTime, notactivationdatetime. - 7 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.