// fusionrest agent · hcm
Benefit Enrollment Opportunities
benefitEnrollmentOpportunities Based on latest (2026.09)
Look up Benefit Enrollment Opportunities. Read-only.
/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities
- Operations
- GET (list)GET (one)
- Record key
PersonNumber- Required on create
- no create on this resource
- At a glance
- 28 fields2 finders0 children
Try it
Response fields ·
Filters (q)
Only attributes Oracle marks as searchable are offered.
Finder
Paging and options
limit
GET /hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities?fields=AutomaticAssignedDate,BenefitRelationId,BenefitRelationName,BenefitRelationType,CreatedBy&limit=25&onlyData=true
Response shape (placeholders)
{
"items": [
{
"AutomaticAssignedDate": "2026-01-31",
"BenefitRelationId": 0,
"BenefitRelationName": "<string, max 240>",
"BenefitRelationType": "<string, max 30>",
"CreatedBy": "<string, max 64>"
}
],
"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 28
| Attribute | Type | Use |
|---|---|---|
AutomaticAssignedDate | date | Read-only |
BenefitRelationId | number | Read-onlySearchable |
BenefitRelationName | text · max 240 | Read-only |
BenefitRelationType | text · max 30 | Read-only |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-only |
DefaultAssignedDate | date | Read-only |
ElectableChoicePoplId | number | Read-onlySearchable |
ElectionsMadeDate | date | Read-only |
EnrollmentPeriodEndDate | date | Read-onlySearchable |
EnrollmentPeriodStartDate | date | Read-onlySearchable |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LegalEntityId | number | Read-onlySearchable |
LifeEventName | text · max 240 | Read-onlySearchable |
LifeEventOccuredDate | date | Read-onlySearchable |
LifeEventStatusCode | text · max 30 | Read-only |
LifeEventTypeCode | text · max 30 | Read-onlySearchable |
ObjectVersionNumber | number | Read-only |
PersonId | number | Read-onlySearchable |
PersonName | text · max 240 | Read-onlySearchable |
PersonNumber | text · max 30 | Read-onlySearchable |
PlanId | number | Read-onlySearchable |
PlanName | text · max 240 | Read-onlySearchable |
ProcessingEndDate | date | Read-only |
ProgramId | number | Read-onlySearchable |
ProgramName | text · max 240 | Read-onlySearchable |
VisibleToEmployeeFlag | yes/no · max 240 | 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.
findByEventAttr·LifeEventNameLifeEventOccuredDatefindByPersonNumber·PersonNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunitiesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByEventAttrfor 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.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AutomaticAssignedDate, notautomaticassigneddate. - 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.