Partner Programs
partnerPrograms Based on latest (2026.09)
Create, change, delete and look up Partner Programs, with partner program countries, program benefit details and program tiers. Actions include delete.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE19 actions
- Record key
ProgramNumber- Required on create
ProgramNameProgramType- At a glance
- 23 fields2 finders12 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/partnerPrograms?fields=CountryNames,CreatedBy,CreationDate,DeleteFlag,EndDateActive&limit=25&onlyData=true
{
"items": [
{
"CountryNames": "<string>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"DeleteFlag": false,
"EndDateActive": "2026-01-31"
}
],
"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 23
| Attribute | Type | Use |
|---|---|---|
CountryNames | text | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DeleteFlag | yes/no | Read-only |
EndDateActive | date | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
OwnerPartyNumber | text · max 30 | Read-onlySearchable |
PartnerProgramId | number | Optional on createSearchable |
ProgramDescription | text · max 1000 | Optional on createUpdatableSearchable |
ProgramManagerId | number | Optional on createUpdatable |
ProgramManagerName | text · max 360 | Optional on createUpdatableSearchable |
ProgramName | text · max 150 | Required on createUpdatableSearchable |
ProgramNumber | text · max 30 | Optional on createSearchable |
ProgramType | text · max 30 | Required on createUpdatableSearchable |
ProgramTypeMeaning | text · max 80 | Read-only |
PublishAllowed | yes/no | Read-only |
StartDateActive | date | Optional on createUpdatableSearchable |
StatusCode | text · max 30 · default D | Optional on createUpdatableSearchable |
TerminateAllowed | yes/no | Read-only |
UnPublishAllowed | yes/no | Read-only |
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.
ProgramNumberRF·ProgramNumberUniqueProgramNumber·ProgramNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 12
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/<name>. Add them to a GET with expand.
AttachmentsGET · POST · PATCH · DELETE Attachments · 32 fields · 1 findersAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamePartnerProgramCountriesGET · POST · PATCH · DELETE Countries · 9 fieldsCountryCodeCountryNameCreatedByCreationDateDeleteFlagLastUpdateDateLastUpdatedByPartnerProgramIdProgramCountryIdProgramBenefitDetailsGET · POST · PATCH · DELETE Program Benefit Details · 18 fieldsBenefitListValueBenefitValueCategoryCodeCreatedByCreationDateDataTypeDeleteFlagDescriptionLastUpdateDateLastUpdateLoginLastUpdatedByNamePartnerProgramIdProgramBenefitDetailIdProgramBenefitIdTierIdTierNameUpdateFlagsmartActionsGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValueProgramTiersGET · POST · PATCH · DELETE Tiers · 12 fields · 2 findersBadgeImageNameCreatedByCreationDateDeleteFlagEnrollmentCountLastUpdateDateLastUpdatedByNamePartnerProgramIdProgramTierIdRankingTierIdsmartActionsGET 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 19
POST …/{ProgramNumber}/action/deletePOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/executeActionForRows·payloadPOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/getActionsForRows·payloadPOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/getEntitiesPOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/action/processMassAction·payloadPOST …/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}/child/smartActions/{partnerPrograms_ProgramBenefitDetails_smartActions_Id}/action/executeActionPOST …/{ProgramNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{ProgramNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{ProgramNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{ProgramNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{ProgramNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{ProgramNumber}/child/smartActions/action/getEntitiesPOST …/{ProgramNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{ProgramNumber}/child/smartActions/action/processMassAction·payloadPOST …/{ProgramNumber}/child/smartActions/{partnerPrograms_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/partnerProgramsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ProgramNumberRFfor 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:EndDateActive, notenddateactive. - 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.