Benefit Plans List of Values
benefitPlansLOV Based on latest (2026.09)
Look up the list of values for Benefit Plans.
The record key benefitPlansLOVUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)
- Record key
benefitPlansLOVUniqID- Required on create
- no create on this resource
- At a glance
- 14 fields4 finders0 children1 file/large text fields
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/benefitPlansLOV?fields=CreatedBy,CreationDate,EffectiveEndDate,EffectiveStartDate,LastUpdateDate&limit=25&onlyData=true
{
"items": [
{
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"EffectiveEndDate": "2026-01-31",
"EffectiveStartDate": "2026-01-31",
"LastUpdateDate": "2026-01-31T09:00:00+00:00"
}
],
"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 14
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EffectiveEndDate | date | Read-onlySearchable |
EffectiveStartDate | date | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
Name | text · max 240 | Read-onlySearchable |
ObjectVersionNumber | number | Read-onlySearchable |
PlanId | number | Read-onlySearchable |
PlanInformation | text | Read-onlySearchable |
PlanTypeId | number | Read-onlySearchable |
ShortCode | text · max 30 | Read-onlySearchable |
ShortName | text · max 30 | Read-onlySearchable |
WebAddress | text · max 240 | Read-onlySearchable |
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 4
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByCourtOrderPlanTypeId·PlanTypeIdSysEffectiveDatefindByName·NameSysEffectiveDatefindByPlanMustBeInProgram·SysEffectiveDatefindByPlanNotInProgram·SysEffectiveDate
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/benefitPlansLOVand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByCourtOrderPlanTypeIdfor 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:CreatedBy, notcreatedby. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- 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.