Oracle Fusion HCM endpoint reference

Workload Plans REST API

Get all workload plans

GET https://your-pod.oraclecloud.com/hcmRestApi/resources/11.13.18.05/workloadPlans

Everything on this page is extracted from Oracle's official OpenAPI specification for Fusion Cloud HCM: 20 queryable q fields, and 1 child resource. Unsure how q works? See the Oracle HCM API guide.

Supported operations

DELETE /workloadPlans/{id}
GET /workloadPlans
GET /workloadPlans/{id}
PATCH /workloadPlans/{id}
POST /workloadPlans

Queryable q fields (20)

Only these fields can appear in a q filter expression on /workloadPlans. Filtering on any other field returns 400 Bad Request.

Example q request

GET /hcmRestApi/resources/11.13.18.05/workloadPlans?q=EndDate='<value>'&onlyData=true&limit=25
Field Type Operators
EndDate string = !=
FridayIncludedFlag boolean = !=
IsConsolidatedFlag boolean = !=
MondayIncludedFlag boolean = !=
SaturdayIncludedFlag boolean = !=
SchedUnitId integer = !=
ShiftId integer = !=
ShiftTypeId integer = !=
StartDate string = !=
SundayIncludedFlag boolean = !=
ThursdayIncludedFlag boolean = !=
TuesdayIncludedFlag boolean = !=
WednesdayIncludedFlag boolean = !=
WorkloadImportTag string = !=
WorkloadMode string = !=
WorkloadPlanCode string = !=
WorkloadPlanId integer = !=
WorkloadType string = !=
WorkloadUOM string = !=
WorkloadValue number = !=

Child resources (1)

Each child is reachable at /workloadPlans/{id}/child/<name> and most can also be inlined with expand.

WorkloadPlansRestDFFVL

Response fields (48)

Top-level attributes returned for each row. Use fields= to request a subset and shrink the payload.

BusinessUnitNameCompetencyIdDepartmentIdDepartmentNameEndAfterMidnightFlagEndDateEndTimeFridayIncludedFlagIsConsolidatedFlagJobCodeJobFamilyIdJobFamilyNameJobIdJobProfileTypeJobSetCodeLocationCodeLocationIdLocationNameLocationSetCodeMondayIncludedFlagOtherQualificationOtherQualificationIdOtherQualificationTypePositionCodePositionIdSaturdayIncludedFlagSchedUnitIdSchedulingGroupCodeShiftIdShiftNameShiftTypeCodeShiftTypeExtendedCodeShiftTypeExtendedCodeNameShiftTypeIdStartDateStartTimeSundayIncludedFlagThursdayIncludedFlagTuesdayIncludedFlagWednesdayIncludedFlagWorkloadImportTagWorkloadModeWorkloadPlanCodeWorkloadPlanIdWorkloadPlansRestDFFVLWorkloadTypeWorkloadUOMWorkloadValue

Build this query visually in OPAL

OPAL bundles this endpoint — and 59,000+ more — fully searchable offline, with a visual Q Builder and Finder Builder that only offer the fields listed above, so your filter can't 400. Download free · see features.

Related reference & reading