Program Enrollments
programEnrollments Based on latest (2026.09)
Create, change and look up Program Enrollments, with notes, partner program and program benefit details.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)19 actions
- Record key
EnrollmentNumber- Required on create
PartnerCompanyNumberPartnerPartyIdPartnerProgramIdProgramNameProgramNumber- At a glance
- 33 fields3 finders12 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/programEnrollments?fields=ActiveEnrollment,ApprovalDate,CreatedBy,CreationDate,EnrollmentNumber&limit=25&onlyData=true
{
"items": [
{
"ActiveEnrollment": "<string>",
"ApprovalDate": "2026-01-31",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"EnrollmentNumber": "<string, max 30>"
}
],
"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 33
| Attribute | Type | Use |
|---|---|---|
ActiveEnrollment | text | Read-onlySearchable |
ApprovalDate | date | Read-only |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EnrollmentNumber | text · max 30 | Optional on createSearchable |
EnrollmentStatus | text · max 30 · default DRAFT | Optional on createUpdatableSearchable |
ExpirationDate | date | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
PartnerCompanyNumber | text · max 30 | Required on createSearchable |
PartnerName | text | Optional on createUpdatable |
PartnerPartyId | number | Required on createSearchable |
PartnerPartyName | text · max 360 | Read-onlySearchable |
PartnerProgramId | number | Required on createSearchable |
PartnerTierId | number | Read-onlySearchable |
PrimaryContactId | number | Optional on createUpdatableSearchable |
ProgramAccessable | yes/no | Read-only |
ProgramDescription | text · max 1000 | Read-onlySearchable |
ProgramEnrollmentId | number | Optional on createSearchable |
ProgramName | text · max 150 | Required on createSearchable |
ProgramNumber | text · max 30 | Required on createSearchable |
RemainingDays | text · max 255 | Read-only |
RenewAllowed | yes/no | Read-only |
RenewedEnrollment | text · max 255 | Read-onlySearchable |
RenewedFromEnrollmentNumber | text | Read-only |
RenewedFromId | number | Read-onlySearchable |
StartDate | date | Optional on createUpdatableSearchable |
SubmissionDate | date | Optional on createUpdatable |
SubmitAllowed | yes/no | Read-only |
TerminateAllowed | yes/no | Read-only |
TerminationDate | date | Read-only |
WithdrawAllowed | 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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
EnrollmentNumber·EnrollmentNumberEnrollmentNumberRF·EnrollmentNumberForRollup
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/programEnrollments/{EnrollmentNumber}/child/<name>. Add them to a GET with expand.
AttachmentsGET · POST · PATCH · DELETE Attachments · 32 fields · 1 findersAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameNotesGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodesmartActionsGET Smart Actions · 27 fields · 5 findersActionContextParametersActionIntentActionSourceActiveFlagApplicationRolesConditionConfirmationMessageContentTypeContextualFlagDataPrivilegeDisplayLabelEntityHrefIncludedInIncludedInApplicationInternalFlagMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserPrivilegeUserActionNavigationGET 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 findersBindingSystemActionFlagURLBindingIdURLBindingNameValuePartnerProgramGET Partner Programs · 23 fields · 2 findersCountryNamesCreatedByCreationDateDeleteFlagEndDateActiveLastUpdateDateLastUpdateLoginLastUpdatedByOwnerPartyNumberPartnerProgramIdProgramDescriptionProgramManagerIdProgramManagerNameProgramNameProgramNumberProgramTypeProgramTypeMeaningPublishAllowedStartDateActiveStatusCodeTerminateAllowedUnPublishAllowedUpdateFlagProgramBenefitDetailsGET Program Benefit Details · 18 fieldsBenefitListValueBenefitValueCategoryCodeCreatedByCreationDateDataTypeDeleteFlagDescriptionLastUpdateDateLastUpdateLoginLastUpdatedByNamePartnerProgramIdProgramBenefitDetailIdProgramBenefitIdTierIdTierNameUpdateFlagsmartActionsGET Smart Actions · 27 fields · 5 findersActionContextParametersActionIntentActionSourceActiveFlagApplicationRolesConditionConfirmationMessageContentTypeContextualFlagDataPrivilegeDisplayLabelEntityHrefIncludedInIncludedInApplicationInternalFlagMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserPrivilegeUserActionNavigationGET 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 …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/executeActionForRows·payloadPOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/getActionsForRows·payloadPOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/getEntitiesPOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/action/processMassAction·payloadPOST …/{EnrollmentNumber}/child/Notes/{NoteId}/child/smartActions/{programEnrollments_Notes_smartActions_Id}/action/executeActionPOST …/{EnrollmentNumber}/child/PartnerProgram/{PartnerProgramId}/action/deletePOST …/{EnrollmentNumber}/child/smartActions/action/executeActionForRows·payloadPOST …/{EnrollmentNumber}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{EnrollmentNumber}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{EnrollmentNumber}/child/smartActions/action/getActionsForRows·payloadPOST …/{EnrollmentNumber}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{EnrollmentNumber}/child/smartActions/action/getEntitiesPOST …/{EnrollmentNumber}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{EnrollmentNumber}/child/smartActions/action/processMassAction·payloadPOST …/{EnrollmentNumber}/child/smartActions/{programEnrollments_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/programEnrollmentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
EnrollmentNumberfor 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:EnrollmentNumber, notenrollmentnumber. - 20 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.