// fusionrest agent · hcm

Benefit Year Periods

benefitYearPeriods Based on latest (2026.09)

Create, change, delete and look up Benefit Year Periods. Actions include generate multiple year periods.

/hcmRestApi/resources/11.13.18.05/benefitYearPeriods
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
I want to…List the latest 25Count recordsGet one recordCreate oneUpdate one

Try it

Response fields ·
Filters (q)

Only attributes Oracle marks as searchable are offered.

Paging and options
limit
Endpoint and headers
GET /hcmRestApi/resources/11.13.18.05/benefitYearPeriods?fields=CreatedBy,CreationDate,EndDate,LastUpdateDate,LastUpdatedBy&limit=25&onlyData=true
Response shape (placeholders)
{
  "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

AttributeTypeUse
CreatedBytext · max 64Read-onlySearchable
CreationDatedate-timeRead-onlySearchable
EndDatedateOptional on createUpdatableSearchable
LastUpdateDatedate-timeRead-onlySearchable
LastUpdatedBytext · max 64Read-onlySearchable
LimitationYearEndDatedateOptional on createUpdatableSearchable
LimitationYearStartDatedateOptional on createUpdatableSearchable
PeriodTypetext · max 30Optional on createUpdatableSearchable
PeriodTypeMeaningtext · max 255Read-only
StartDatedateOptional on createUpdatableSearchable
YearPeriodIdnumberOptional 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

Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.

Use in AI Agent Studio

More in For Builders.

Pitfalls