Benefit Year Periods
benefitYearPeriods Based on latest (2026.09)
Create, change, delete and look up Benefit Year Periods. Actions include generate multiple year periods.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
YearPeriodId- Required on create
- none marked
- At a glance
- 11 fields0 finders0 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/benefitYearPeriods?fields=CreatedBy,CreationDate,EndDate,LastUpdateDate,LastUpdatedBy&limit=25&onlyData=true
{
"items": [
{
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"EndDate": "2026-01-31",
"LastUpdateDate": "2026-01-31T09:00:00+00:00",
"LastUpdatedBy": "<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 11
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EndDate | date | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LimitationYearEndDate | date | Optional on createUpdatableSearchable |
LimitationYearStartDate | date | Optional on createUpdatableSearchable |
PeriodType | text · max 30 | Optional on createUpdatableSearchable |
PeriodTypeMeaning | text · max 255 | Read-only |
StartDate | date | Optional on createUpdatableSearchable |
YearPeriodId | number | Optional on createSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Actions 1
POST …/action/generateMultipleYearPeriods·startYearendYear
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
/hcmRestApi/resources/11.13.18.05/benefitYearPeriodsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - 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:EndDate, notenddate. - 5 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.