Action Plans
actionplans Based on latest (2026.09)
Create, change, delete and look up Action Plans, with action plan action. Actions include add action to object and add adhoc actionto action plan.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE10 actions
- Record key
ActionPlanId- Required on create
ObjectEntityNameObjectId- At a glance
- 47 fields1 finders2 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/actionplans?fields=ActionId,ActionNumber,ActionObjectEntitySubtype,ActionObjectEntityType,ActionObjectId&limit=25&onlyData=true
{
"items": [
{
"ActionId": 0,
"ActionNumber": "<string>",
"ActionObjectEntitySubtype": "<string, max 400>",
"ActionObjectEntityType": "<string, max 400>",
"ActionObjectId": 0
}
],
"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 47
| Attribute | Type | Use |
|---|---|---|
ActionId | number | Optional on createSearchable |
ActionNumber | text | Optional on create |
ActionObjectEntitySubtype | text · max 400 | Read-onlySearchable |
ActionObjectEntityType | text · max 400 | Read-onlySearchable |
ActionObjectId | number | Optional on createUpdatableSearchable |
ActionObjectReferenceNumber | text · max 100 | Optional on createUpdatableSearchable |
ActionPlanId | number | Read-onlySearchable |
ActionPlanNumber | text · max 30 | Optional on createSearchable |
ActionPlanTypeCd | text · max 30 · default ORA_SVC_TEMPLATE | Optional on createSearchable |
ActionPlanTypeCdMeaning | text · max 255 | Read-onlySearchable |
ActionStatusCd | text · max 30 | Optional on createUpdatableSearchable |
ActionStatusCdMeaning | text · max 255 | Optional on createUpdatableSearchable |
ActualCompletionDate | date-time | Optional on createUpdatableSearchable |
AdditionalInformation | text · max 2000 | Optional on createUpdatableSearchable |
CalendarId | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DeleteFlag | yes/no | Read-only |
DeletedFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
ExpectedCompletionDate | date-time | Optional on createUpdatableSearchable |
InitialCompletionDate | date-time | Optional on createUpdatableSearchable |
InitiateFlag | yes/no · default false | Optional on createUpdatableSearchable |
LastRefreshedDate | date-time | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Message | text | Optional on createUpdatable |
Name | text · max 400 | Optional on createUpdatableSearchable |
ObjectEntityName | text · max 400 | Required on createSearchable |
ObjectEntityNameMeaning | text · max 255 | Optional on createUpdatableSearchable |
ObjectId | number | Required on createSearchable |
ObjectNumber | text | Optional on createSearchable |
OrderNumber | number | Optional on createUpdatableSearchable |
ProcessInstanceId | text · max 500 | Optional on createUpdatableSearchable |
ProcessStatus | text · max 100 | Optional on createUpdatableSearchable |
SchedulePuid | text · max 120 | Read-onlySearchable |
StartDate | date-time | Optional on createUpdatableSearchable |
Status | text | Read-onlySearchable |
StatusCd | text · max 30 | Optional on createUpdatableSearchable |
StatusCdMeaning | text · max 255 | Optional on createUpdatableSearchable |
StatusDetails | text · max 2000 | Optional on createUpdatableSearchable |
TemplateId | number | Optional on createUpdatableSearchable |
TemplateNumber | text · max 30 | Optional on createSearchable |
UpdateFlag | yes/no | Read-only |
UserDecisionCd | text | Optional on create |
WorkflowActionId | number | Optional on createUpdatableSearchable |
WorkflowId | number | Optional on createUpdatableSearchable |
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 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ActionPlanNumberRowFinder·ActionPlanNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/<name>. Add them to a GET with expand.
actionPlanActionGET · POST · PATCH · DELETE Action Plan Actions · 49 fieldsActionDescriptionActionIdActionNameActionNumberActionPlanActionIdActionPlanActionNumberActionPlanIdActionPlanNumberCreatedByCreationDateDelayedFlagDeleteFlagDeletedFlagEndDateEndDateReadOnlyFlagExpectedCompletionDateExpectedStartDateLastUpdateDateLastUpdateLoginLastUpdatedByLeadTimeLeadTimeUnitLeadTimeUnitMeaningMandatoryFlagObjectEntityNameObjectEntityNameMeaningObjectEntitySubtypeObjectEntityTypeObjectEntityTypeMeaningObjectIdObjectReferenceNumberOrderNumberOwnerNamePrerequisitesProcessInstanceIdProcessStatusSkipFlagStartDateStatusCdStatusCdMeaningStatusDetailsTemplateIdTemplateNumberTemplateTemplateIdUpdateFlagVisibilityCdVisibilityCdMeaningWorkflowActionIdWorkflowIdactionPlanActionRelationGET · POST · PATCH · DELETE Action Plan Action Relations · 14 fields · 1 findersActionPlanActionIdActionPlanActionNumberActionStatusCdCreatedByCreationDateDeleteFlagDeletedFlagDepActionPlanActionIdDepActionPlanActionNumberLastUpdateDateLastUpdateLoginLastUpdatedByRelationIdUpdateFlag
Actions 10
POST …/action/addActionToObject·customAttributeValuesactionNumberobjectNumberobjectEntityNameplanAttributeValuesPOST …/action/addAdhocActiontoActionPlan·actionNumberactionPlanNumberPOST …/action/cancelActionPlan·actionPlanNumberPOST …/action/getActionMappings·actionPlanActionNumberactionPlanNumberPOST …/action/getProcessAccessTokenPOST …/action/processSignalObject·objectReferenceNumberPOST …/action/recreateObjectForActionPlanAction·actionPlanActionIdPOST …/action/refreshActionPlan·actionPlanIdrefreshProcesssoftRefreshPOST …/action/refreshActionPlanAction·actionPlanActionNumberPOST …/action/updateObjectDetailsToPlan·actionPlanActionNumberobjectIdentifieractionPlanNumber
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/actionplansand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ActionPlanNumberRowFinderfor 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:ActionId, notactionid. - 13 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.