Oracle Fusion HCM endpoint reference

Flow Instances REST API

Get all payroll flow instances

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

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

Supported operations

GET /flowInstances
GET /flowInstances/{id}

Queryable q fields (23)

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

Example q request

GET /hcmRestApi/resources/11.13.18.05/flowInstances?q=CreatedBy='<value>'&onlyData=true&limit=25
Field Type Operators
BaseFlowId integer = !=
CompletedTasks integer = !=
CreatedBy string = !=
CreationDate string = !=
FlowInstanceId integer = !=
FlowName string = !=
GroupStatus string = !=
IsDataLoader string = !=
IsExtract string = !=
LastUpdateDate string = !=
LastUpdatedBy string = !=
LegislativeDataGroupId integer = !=
NumberOfTasks integer = !=
PayrollId integer = !=
ProcessDate string = !=
Records number = !=
RecurSchFormulaId integer = !=
RecurringFlag boolean = !=
RootFlowInstanceId integer = !=
ScheduleEndDate string = !=
ScheduledDate string = !=
Status string = !=
TaskType string = !=

Child resources (1)

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

checklists

Response fields (24)

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

BaseFlowIdCompletedTasksCreatedByCreationDateFlowInstanceIdFlowNameGroupStatusIsDataLoaderIsExtractLastUpdateDateLastUpdatedByLegislativeDataGroupIdNumberOfTasksPayrollIdProcessDateRecordsRecurSchFormulaIdRecurringFlagRootFlowInstanceIdScheduleEndDateScheduledDateStatusTaskTypechecklists

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