Workload Plan
workloadPlans Based on latest (2026.09)
Create, change, delete and look up Workload Plan. Actions include find by advanced search query.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
WorkloadPlanId- Required on create
WorkloadPlanCodeWorkloadType- At a glance
- 47 fields2 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/workloadPlans?fields=BusinessUnitName,CompetencyId,DepartmentId,DepartmentName,EndAfterMidnightFlag&limit=25&onlyData=true
{
"items": [
{
"BusinessUnitName": "<string, max 80>",
"CompetencyId": 0,
"DepartmentId": 0,
"DepartmentName": "<string, max 80>",
"EndAfterMidnightFlag": false
}
],
"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 47
| Attribute | Type | Use |
|---|---|---|
BusinessUnitName | text · max 80 | Optional on createUpdatable |
CompetencyId | number | Optional on createUpdatable |
DepartmentId | number | Optional on createUpdatable |
DepartmentName | text · max 80 | Optional on createUpdatable |
EndAfterMidnightFlag | yes/no | Optional on createUpdatable |
EndDate | date | Optional on createUpdatableSearchable |
EndTime | text · max 80 | Optional on createUpdatable |
FridayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
IsConsolidatedFlag | yes/no · max 255 | Read-onlySearchable |
JobCode | text · max 80 | Optional on createUpdatable |
JobFamilyId | number | Optional on createUpdatable |
JobFamilyName | text · max 80 | Optional on createUpdatable |
JobId | number | Optional on createUpdatable |
JobProfileType | text · max 80 | Optional on createUpdatable |
JobSetCode | text · max 80 | Optional on createUpdatable |
LocationCode | text · max 80 | Optional on createUpdatable |
LocationId | number | Optional on createUpdatable |
LocationName | text · max 80 | Optional on createUpdatable |
LocationSetCode | text · max 80 | Optional on createUpdatable |
MondayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
OtherQualification | text · max 250 | Optional on createUpdatable |
OtherQualificationId | number | Optional on createUpdatable |
OtherQualificationType | text · max 80 | Optional on createUpdatable |
PositionCode | text · max 80 | Optional on createUpdatable |
PositionId | number | Optional on createUpdatable |
SaturdayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
SchedUnitId | number | Read-onlySearchable |
SchedulingGroupCode | text · max 80 | Optional on createUpdatable |
ShiftId | number | Optional on createUpdatableSearchable |
ShiftName | text · max 80 | Optional on createUpdatable |
ShiftTypeCode | text | Optional on createUpdatable |
ShiftTypeExtendedCode | text · max 80 | Optional on createUpdatable |
ShiftTypeExtendedCodeName | text · max 80 | Optional on createUpdatable |
ShiftTypeId | number | Optional on createUpdatableSearchable |
StartDate | date | Optional on createUpdatableSearchable |
StartTime | text · max 80 | Optional on createUpdatable |
SundayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ThursdayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
TuesdayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
WednesdayIncludedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
WorkloadImportTag | text · max 30 | Optional on createUpdatableSearchable |
WorkloadMode | text · max 1 | Optional on createUpdatableSearchable |
WorkloadPlanCode | text · max 30 | Required on createSearchable |
WorkloadPlanId | number | Optional on createSearchable |
WorkloadType | text · max 30 | Required on createUpdatableSearchable |
WorkloadUOM | text · max 30 | Optional on createUpdatableSearchable |
WorkloadValue | number | Optional 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 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByWorkloadPlanCode·WorkloadPlanCodefindByWorkloadPlanId·WorkloadPlanId
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/workloadPlans/{WorkloadPlanId}/child/<name>. Add them to a GET with expand.
WorkloadPlansRestDFFVLGET · POST · PATCH · DELETE Workload Plan DFF · 3 fieldsWorkloadPlanId__FLEX_Context__FLEX_Context_DisplayValue
Actions 1
POST …/action/findByAdvancedSearchQuery·offsetquerylimitsearchFieldsfilterssortdisplayFieldsautocompleteQuery
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/workloadPlansand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByWorkloadPlanCodefor 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:BusinessUnitName, notbusinessunitname. - 2 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.