Business Plans
businessPlans Based on latest (2026.09)
Create, change, delete and look up Business Plans, with business plan resource, goals and note.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE45 actions
- Record key
BusinessPlanId- Required on create
NamePeriodTypeCodeStatusCode- At a glance
- 39 fields2 finders27 children2 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/businessPlans?fields=AISummary,BusinessPlanClassCode,BusinessPlanId,BusinessPlanNumber,BusinessPlanOwnerId&limit=25&onlyData=true
{
"items": [
{
"AISummary": "<string>",
"BusinessPlanClassCode": "PARTNER",
"BusinessPlanId": 0,
"BusinessPlanNumber": "<string, max 64>",
"BusinessPlanOwnerId": 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 39
| Attribute | Type | Use |
|---|---|---|
AISummary | text | Optional on createUpdatable |
BusinessPlanClassCode | text · max 20 · default PARTNER | Optional on createUpdatableSearchable |
BusinessPlanId | number | Optional on createSearchable |
BusinessPlanNumber | text · max 64 | Optional on createSearchable |
BusinessPlanOwnerId | number | Optional on createUpdatable |
BusinessPlanOwnerNumber | text · max 30 | Read-onlySearchable |
BusinessPlanTypeCode | text · max 30 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CustomerId | number | Optional on createUpdatableSearchable |
CustomerName | text · max 360 | Read-onlySearchable |
CustomerNumber | text · max 30 | Read-onlySearchable |
CustomerPartyType | text · max 30 | Read-onlySearchable |
DeleteFlag | yes/no | Read-only |
Description | text · max 3000 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Name | text · max 275 | Required on createUpdatableSearchable |
OrigCreationDate | date-time | Optional on createUpdatableSearchable |
OwnerResourceName | text · max 360 | Optional on createUpdatableSearchable |
PartnerId | number | Optional on createUpdatable |
PartnerName | text · max 80 | Read-only |
PartnerNumber | text · max 30 | Optional on createSearchable |
PartnerPartyDisplayName | text · max 360 | Optional on createUpdatableSearchable |
PeriodEndDate | date | Read-onlySearchable |
PeriodEndDisplayName | text · max 30 | Optional on createUpdatable |
PeriodEndName | text · max 30 | Optional on createUpdatableSearchable |
PeriodRangeDisplayName | text · max 80 | Optional on createUpdatableSearchable |
PeriodSetName | text · max 15 | Optional on createUpdatable |
PeriodStartDate | date | Read-onlySearchable |
PeriodStartDisplayName | text · max 30 | Optional on createUpdatable |
PeriodStartName | text · max 30 | Optional on createUpdatableSearchable |
PeriodTypeCode | text · max 30 | Required on createUpdatableSearchable |
SWOTData | text | Optional on createUpdatable |
SourceType | text | Read-onlySearchable |
StatusCode | text · max 30 | Required on createUpdatableSearchable |
TargetRevnAmt | number | Optional on createUpdatableSearchable |
UpdateFlag | yes/no | Read-only |
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 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AllBusinessPlansFinderMyBusinessPlansFinder·BusinessPlanOwnerId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 27
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/<name>. Add them to a GET with expand.
BusinessPlanAttachmentsGET · POST · PATCH · DELETE Attachments · 32 fields · 1 findersAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameBusinessPlanResourceGET · POST · PATCH · DELETE Business Plan Resources · 21 fields · 2 findersAccessLevelCodeBusinessPlanIdBusinessPlanNumberBusinessPlanResourceIdBusinessPlanResourceNumberCreatedByCreationDateDenormMgrIdEmailAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByManagerNameMemberFunctionCodeOrganizationNameOwnerFlagResourceIdResourceNameResourceNumberRoleNamesmartActionsGET · POST · PATCH · DELETE Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueGoalsGET · POST · PATCH · DELETE Goals · 20 fields · 1 findersBusinessPlanIdCreatedByCreationDateEndDateEndDisplayPeriodNameEndPeriodNameGoalDescriptionGoalIdGoalNameGoalNumberGoalOwnerIdLastUpdateDateLastUpdateLoginLastUpdatedByOwnerPartyNameOwnerPartyNumberPeriodTypeCodeStartDateStartDisplayPeriodNameStartPeriodNameSalesObjectivesGET · POST · PATCH · DELETE Sales Objectives · 44 fieldsAccountIdAccountNameAccountNumberActualValueBusinessPlanIdBusinessPlanNameBusinessPlanNumberCreatedByCreationDateCurrencyCodeDeleteFlagDescriptionEndDisplayPeriodNameEndPeriodNameGeographyIdGeographyKeyGeographyNameGoalIdGoalNumberLastUpdateDateLastUpdateLoginLastUpdatedByNameObjectiveIdObjectiveNumberObjectiveOwnerIdObjectiveTypeCodeObjectiveTypeNameOrigCreationDateOwnerPartyNameOwnerPartyNumberPeriodEndDatePeriodStartDatePeriodTypeCodePeriodTypeNameProductGroupIdProductGroupNameProductGroupReferenceNumberStartDisplayPeriodNameStartPeriodNameTargetValueUnitOfMeasureCodeUnitOfMeasureNameUpdateFlagInitiativesGET · POST · PATCH · DELETE Initiatives · 15 fieldsBusinessPlanIdBusinessPlanNumberCreatedByCreationDateCustomerIdGoalIdInitiativeIdLastUpdateDateLastUpdateLoginLastUpdatedByLeadIdLeadNumberObjectiveIdOptyIdOptyNumbersmartActionsGET · POST · PATCH · DELETE Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueNoteGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodesmartActionsGET · POST · PATCH · DELETE Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueSwotGET · POST · PATCH · DELETE SWOTs · 11 fieldsBusinessPlanIdBusinessPlanNumberCreatedByCreationDateDescriptionLastUpdateDateLastUpdateLoginLastUpdatedBySWOTIdSWOTNumberSWOTTypeCodesmartActionsGET · POST · PATCH · DELETE Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValuesmartActionsGET · POST · PATCH · DELETE Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 45
POST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/executeActionForRows·payloadPOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/getActionsForRows·payloadPOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/getEntitiesPOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/action/processMassAction·payloadPOST …/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}/child/smartActions/{businessPlans_BusinessPlanResource_smartActions_Id}/action/executeActionPOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/getEntitiesPOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/action/processMassAction·payloadPOST …/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions/{businessPlans_Goals_smartActions_Id}/action/executeActionPOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/executeActionForRows·payloadPOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/getActionsForRows·payloadPOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/getEntitiesPOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/action/processMassAction·payloadPOST …/{BusinessPlanId}/child/Note/{NoteId}/child/smartActions/{businessPlans_Note_smartActions_Id}/action/executeActionPOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/executeActionForRows·payloadPOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/getActionsForRows·payloadPOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/getEntitiesPOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/action/processMassAction·payloadPOST …/{BusinessPlanId}/child/Swot/{SWOTId}/child/smartActions/{businessPlans_Swot_smartActions_Id}/action/executeActionPOST …/{BusinessPlanId}/child/smartActions/action/executeActionForRows·payloadPOST …/{BusinessPlanId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{BusinessPlanId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/smartActions/action/getActionsForRows·payloadPOST …/{BusinessPlanId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{BusinessPlanId}/child/smartActions/action/getEntitiesPOST …/{BusinessPlanId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{BusinessPlanId}/child/smartActions/action/processMassAction·payloadPOST …/{BusinessPlanId}/child/smartActions/{businessPlans_smartActions_Id}/action/executeAction
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/businessPlansand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AllBusinessPlansFinderfor 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:AISummary, notaisummary. - 15 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.