Eligibility Objects
eligibilityObjects Based on latest (2026.09)
Create, change, delete and look up Eligibility Objects, with eligibility object profiles.
The record key eligibilityObjectsUniqID 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)POST (create)PATCH (update)DELETE
- Record key
eligibilityObjectsUniqID- Required on create
EffectiveEndDateEffectiveStartDateSourceObjectKeySourceObjectNameSourceObjectValue- At a glance
- 7 fields3 finders1 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/eligibilityObjects?fields=EffectiveEndDate,EffectiveStartDate,EligibilityObjectId,EligibilityObjectType,SourceObjectKey&limit=25&onlyData=true
{
"items": [
{
"EffectiveEndDate": "2026-01-31",
"EffectiveStartDate": "2026-01-31",
"EligibilityObjectId": 0,
"EligibilityObjectType": "<string, max 30>",
"SourceObjectKey": "<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 7
| Attribute | Type | Use |
|---|---|---|
EffectiveEndDate | date | Required on createSearchable |
EffectiveStartDate | date | Required on createSearchable |
EligibilityObjectId | number | Optional on createSearchable |
EligibilityObjectType | text · max 30 | Optional on createUpdatableSearchable |
SourceObjectKey | text · max 30 | Required on createUpdatableSearchable |
SourceObjectName | text · max 30 | Required on createUpdatableSearchable |
SourceObjectValue | text · max 30 | Required on createUpdatableSearchable |
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.
findByEligibilityObjectId·EligibilityObjectIdSysEffectiveDatefindByEligibilityObjectType·EligibilityObjectTypeSysEffectiveDatefindBySourceObjectName·SourceObjectKeySourceObjectNameSourceObjectValueSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/<name>. Add them to a GET with expand.
eligibilityObjectProfilesGET · POST · PATCH · DELETE Eligibility Object Profiles · 7 fieldsEffectiveEndDateEffectiveStartDateEligibilityObjectIdEligibilityObjectProfileIdEligibilityProfileIdEligibilityProfileNameMandatoryFlag
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/eligibilityObjectsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByEligibilityObjectIdfor 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:EffectiveEndDate, noteffectiveenddate. 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. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.