Program Benefits
partnerProgramBenefits Based on latest (2026.09)
Create, change, delete and look up Program Benefits, with benefit list type values and smart actions.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE9 actions
- Record key
ProgramBenefitId- Required on create
DataTypeName- At a glance
- 13 fields0 finders5 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/partnerProgramBenefits?fields=CategoryCode,CreatedBy,CreationDate,DataType,DeleteFlag&limit=25&onlyData=true
{
"items": [
{
"CategoryCode": "<string, max 30>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"DataType": "<string, max 30>",
"DeleteFlag": false
}
],
"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 13
| Attribute | Type | Use |
|---|---|---|
CategoryCode | text · max 30 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
DataType | text · max 30 | Required on createUpdatableSearchable |
DeleteFlag | yes/no | Read-only |
Description | text · max 1000 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LastUpdatedByName | text | Read-onlySearchable |
Name | text · max 155 | Required on createUpdatableSearchable |
ProgramBenefitId | number | Optional on createSearchable |
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.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 5
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/<name>. Add them to a GET with expand.
BenefitListTypeValuesGET · POST · PATCH · DELETE Benefit List Values · 9 fields · 1 findersBenefitListTypeValIdCreatedByCreationDateDeleteFlagLastUpdateDateLastUpdatedByProgramBenefitIdUpdateFlagValueNamesmartActionsGET 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 9
POST …/{ProgramBenefitId}/child/smartActions/action/executeActionForRows·payloadPOST …/{ProgramBenefitId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{ProgramBenefitId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{ProgramBenefitId}/child/smartActions/action/getActionsForRows·payloadPOST …/{ProgramBenefitId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{ProgramBenefitId}/child/smartActions/action/getEntitiesPOST …/{ProgramBenefitId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{ProgramBenefitId}/child/smartActions/action/processMassAction·payloadPOST …/{ProgramBenefitId}/child/smartActions/{partnerProgramBenefits_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/partnerProgramBenefitsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - 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:CategoryCode, notcategorycode. - 8 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.