Benefits Comparison Plans
benefitPlansComparison Based on latest (2026.09)
Look up Benefits Comparison Plans, with estimated costs, feature values and footnotes. Read-only.
- Operations
- GET (list)GET (one)
- Record key
InstanceId- Required on create
- no create on this resource
- At a glance
- 14 fields3 finders6 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/benefitPlansComparison?fields=ComparisonType,EstimatedCostType,EstimatedCostValue,FromDate,ImageId&limit=25&onlyData=true
{
"items": [
{
"ComparisonType": "<string, max 128>",
"EstimatedCostType": "<string, max 80>",
"EstimatedCostValue": "<string, max 1000>",
"FromDate": "2026-01-31",
"ImageId": 0
}
],
"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 |
|---|---|---|
ComparisonType | text · max 128 | Read-onlySearchable |
EstimatedCostType | text · max 80 | Read-only |
EstimatedCostValue | text · max 1000 | Read-only |
FromDate | date | Read-onlySearchable |
ImageId | number | Read-only |
InstanceId | number | Read-onlySearchable |
LegislationCode | text · max 30 | Read-onlySearchable |
Name | text · max 240 | Read-onlySearchable |
TemplateId | number | Read-onlySearchable |
TemplateName | text · max 128 | Read-onlySearchable |
TemplateType | text · max 128 | Read-onlySearchable |
ToDate | date | Read-onlySearchable |
UseGroupsFlag | yes/no · max 30 | Read-only |
UseHeaderFlag | yes/no · max 30 | 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.
findByElectableInstanceId·EffectiveDateInstanceIdPersonIdfindByInstanceId·InstanceIdfindByPlanAttr·EffectiveDateNamePersonIdTemplateIdTemplateName
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 6
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/<name>. Add them to a GET with expand.
estimatedCostsGET Estimated Costs · 3 fieldsEstimatedCostInstanceValueIdOptionNamefeatureValuesGET Feature Values · 14 fieldsCategoryIdCategoryNameFootnoteRefsGroupIdGroupNameInfoTextInstanceValueIdItemIdNameOptionIdOptionNameUseCategoriesFlagUseOptionsFlagValuefootnoteReferencesGET Footnote References · 3 fieldsFootnoteItemIdSequencefootnotesGET Footnotes · 3 fieldsFootnoteItemIdSequencehighlightsGET Highlights · 3 fieldsInstanceValueIdNameValueFlagimagesGET Images · 4 fieldsFileNameImageImageIdName
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/benefitPlansComparisonand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByElectableInstanceIdfor 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:ComparisonType, notcomparisontype. - 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.