Flow Instances
flowInstances Based on latest (2026.09)
Look up Flow Instances, with checklists. Actions include get available actions and perform action. Changes only through its actions.
- Operations
- GET (list)GET (one)4 actions
- Record key
FlowInstanceId- Required on create
- no create on this resource
- At a glance
- 23 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/flowInstances?fields=BaseFlowId,CompletedTasks,CreatedBy,CreationDate,FlowInstanceId&limit=25&onlyData=true
{
"items": [
{
"BaseFlowId": 0,
"CompletedTasks": 0,
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"FlowInstanceId": 0
}
],
"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 23
| Attribute | Type | Use |
|---|---|---|
BaseFlowId | number | Searchable |
CompletedTasks | number | Searchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
FlowInstanceId | number | Searchable |
FlowName | text · max 200 | Searchable |
GroupStatus | text · max 255 | Read-onlySearchable |
IsDataLoader | text · max 2 | Searchable |
IsExtract | text · max 2 | Searchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LegislativeDataGroupId | number | Searchable |
NumberOfTasks | number | Searchable |
PayrollId | number | Searchable |
ProcessDate | date | Searchable |
Records | number | Searchable |
RecurSchFormulaId | number | Searchable |
RecurringFlag | yes/no · max 1 | Searchable |
RootFlowInstanceId | number | Searchable |
ScheduleEndDate | date-time | Searchable |
ScheduledDate | date-time | Searchable |
Status | text | Read-onlySearchable |
TaskType | text · max 20 | Searchable |
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.
findByStatus·Status
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/flowInstances/{FlowInstanceId}/child/<name>. Add them to a GET with expand.
checklistsGET Checklists · 15 fieldsBaseFlowTaskIdChecklistNameCreatedByCreationDateFlowInstanceIdFlowTaskInstanceIdGroupStatusIsCancellingLastUpdateDateLastUpdatedByLoggingLevelOwnerIdOwnerTypeRecordsStatus
Actions 4
POST …/{FlowInstanceId}/action/getAvailableActionsPOST …/{FlowInstanceId}/action/performAction·actionNamePOST …/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}/action/getAvailableActionsPOST …/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}/action/performAction·ownerTypeownerIdactionName
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/flowInstancesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByStatusfor 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:BaseFlowId, notbaseflowid. - 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.