// fusionrest agent · hcm
Workforce Schedule Definitions
workforceScheduleDefinitions Based on latest (2026.09)
Look up Workforce Schedule Definitions. Read-only.
/hcmRestApi/resources/11.13.18.05/workforceScheduleDefinitions
- Operations
- GET (list)GET (one)
- Record key
ScheduleId- Required on create
- no create on this resource
- At a glance
- 29 fields1 finders0 children
Try it
Response fields ·
Filters (q)
Only attributes Oracle marks as searchable are offered.
Finder
Paging and options
limit
GET /hcmRestApi/resources/11.13.18.05/workforceScheduleDefinitions?fields=Comments,CreationDate,DepartmentId,DepartmentName,EndDate&limit=25&onlyData=true
Response shape (placeholders)
{
"items": [
{
"Comments": "<string, max 4000>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"DepartmentId": 0,
"DepartmentName": "<string, max 240>",
"EndDate": "2026-01-31"
}
],
"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 29
| Attribute | Type | Use |
|---|---|---|
Comments | text · max 4000 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DepartmentId | number | Read-onlySearchable |
DepartmentName | text · max 240 | Read-onlySearchable |
EndDate | date | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LocationCode | text · max 60 | Read-onlySearchable |
LocationId | number | Read-onlySearchable |
LocationName | text · max 240 | Read-onlySearchable |
OpenDate | date | Read-onlySearchable |
PublishDueDate | date | Read-onlySearchable |
PublishedBy | number | Read-onlySearchable |
PublishedByPersonNumber | text · max 30 | Read-onlySearchable |
PublishedDate | date | Read-onlySearchable |
SchedGenProfileId | number | Read-onlySearchable |
SchedProfileCode | text · max 30 | Read-onlySearchable |
ScheduleId | number | Read-onlySearchable |
SchedulePhaseCode | text · max 23 | Read-onlySearchable |
SchedulePhaseMeaning | text · max 80 | Read-onlySearchable |
ScheduleStatus | text · max 80 | Read-onlySearchable |
ScheduleUnitId | number | Read-onlySearchable |
SelfScheduleCloseDate | date | Read-onlySearchable |
SelfScheduleOpenDate | date | Read-onlySearchable |
StartDate | date | Read-onlySearchable |
StatusCode | text · max 30 | Read-onlySearchable |
UnpublishDate | date-time | Read-onlySearchable |
UnpublishedBy | number | Read-onlySearchable |
UnpublishedByPersonNumber | text · max 30 | Read-onlySearchable |
WorkloadUpdateDate | date-time | Read-onlySearchable |
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 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByScheduleUnitAndDateRange·DepartmentIdDepartmentNameEndDateLocationCodeLocationIdStartDateStatusCode
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/workforceScheduleDefinitionsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByScheduleUnitAndDateRangefor 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.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:Comments, notcomments. - 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.