1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. List of Values
  4. Flow Instances List of Values

Get all payroll flow instances

get

/hcmRestApi/resources/11.13.18.05/flowInstancesLOV

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds payroll flow instances that match the specified primary key criteria.
      Finder Variables
      • FlowInstanceId; integer; Unique identifier for the submitted flow.
    • findByLegislativeDataGroupId Find flow instances based on the legislative data group ID.
      Finder Variables
      • LegislativeDataGroupId; integer; Unique identifier used to retrieve values for a flow instance.
    • findByWord Finds flow instances based on the specified word.
      Finder Variables
      • FilterAttributes; string; Attributes for the search terms.
      • SearchTerms; string; Search term criteria to retrieve data.
      • StartsWithFlag; boolean; Indicates whether search should start with the first character of the filter attribute or not.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AttributeCategory; string; Category to which the attribute belongs to.
    • BaseFlowId; integer; Unique identifier for the flow pattern that the submitted flow instance is associated with.
    • Errored; string; Indicates whether the flow has any erroneous tasks.
    • ExecutionMode; string; Latest action taken for the flow instance, such as roll back or submit.
    • FiCompletedTasks; integer; Number of completed flow tasks in a flow instance.
    • FiPayrollId; integer; Unique identifier for the payroll that's passed as a parameter to the flow instance.
    • FiProcessDate; string; Process date that's passed as a parameter to the flow instance.
    • FiRolledback; string; Indicates whether a flow task has been rolled back or not.
    • FiTaskFlowFlag; boolean; Indicates whether the flow instance is a task flow, standard process, or a report. If the value is Y, then the flow is a task flow.
    • FiTaskStatus; string; Status of flow instances that were grouped based on hierarchy.
    • FiTaskType; string; Indicates whether the flow instance is a task flow, standard process, or report.
    • FiTotalCompleted; number; Number of individual records successfully completed in a flow instance for a standard process.
    • FlowInstanceId; integer; Unique identifier used to retrieve the submitted flow instance.
    • InstanceName; string; Unique identifier used to retrieve the submitted flow instance.
    • InstantiatedBy; string; Unique identifier of the user who submitted the flow instance.
    • LegislativeDataGroupId; integer; Unique identifier for the legislative data group that's used to retrieve the payroll flow instance.
    • MarkedForRetry; string; Indicates whether a task is marked for retry or not.
    • NumberOfTasks; integer; Count of the total tasks in a task flow instance.
    • Progress; integer; Percentage of the standard process that's complete.
    • RecurSchFormulaId; integer; Unique identifier for the fast formula used to schedule a flow instance.
    • RecurSchTimeDefId; integer; Unique identifier for the scheduled time definition.
    • RecurTimeComponent; string; Name of the recurring time component.
    • RecurringFlag; boolean; Determines whether the flow instance that's being processed belongs to the flow instance that was submitted recursively.
    • Reversed; string; Indicates whether the flow instance is reversed or not. The default value is Null.
    • RootFlowInstanceId; integer; Unique identifier for the first flow instance of the recurring schedule.
    • RunId; integer; Unique identifier for the payroll run.
    • ScheduleEndDate; string; Date that indicates the end of a recurring schedule.
    • ScheduledDate; string; Date that indicates the start of a recurring schedule.
    • Status; string; Status of the payroll flow instance.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : flowInstancesLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : flowInstancesLOV-item-response
Type: object
Show Source
Back to Top

Examples

This example shows how to retrieve all flow instances by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H Effective-Of:RangeStartDate=2010-10-12 -X GET https://<hostname>:<portno>/hcmRestApi/resources/11.13.18.05/flowInstancesLOV

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200 OK                     
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "FlowInstanceId": 300100185797460,
      "BaseFlowId": 300100148171996,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "COMPLETED",
      "InstanceName": "SD LOAD JAN DATAFILE",
      "AttributeCategory": null,
      "Errored": "N",
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": null,
      "FiProcessDate": null,
      "FiRolledback": null,
      "FiTaskFlowFlag": false,
      "FiTaskStatus": "COMPLETED",
      "FiTaskType": "PROCESS",
      "FiTotalCompleted": null,
      "InstantiatedBy": "100100013555209",
      "MarkedForRetry": null,
      "NumberOfTasks": null,
      "Progress": 100,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    },
    {
      "FlowInstanceId": 300100185561926,
      "BaseFlowId": 100000021552103,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "COMPLETED",
      "InstanceName": "BHSCalcPayroll",
      "AttributeCategory": null,
      "Errored": "N",
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": 300100038035508,
      "FiProcessDate": "2012-02-15",
      "FiRolledback": null,
      "FiTaskFlowFlag": false,
      "FiTaskStatus": "COMPLETED",
      "FiTaskType": "PROCESS",
      "FiTotalCompleted": 0,
      "InstantiatedBy": "100100013555209",
      "MarkedForRetry": "N",
      "NumberOfTasks": null,
      "Progress": 100,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    },
    {
      "FlowInstanceId": 300100150946002,
      "BaseFlowId": 100000021552078,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "IN_PROGRESS",
      "InstanceName": "AR Recompile Formulas",
      "AttributeCategory": null,
      "Errored": null,
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": null,
      "FiProcessDate": null,
      "FiRolledback": null,
      "FiTaskFlowFlag": null,
      "FiTaskStatus": null,
      "FiTaskType": null,
      "FiTotalCompleted": null,
      "InstantiatedBy": "100100013555209",
      "MarkedForRetry": null,
      "NumberOfTasks": null,
      "Progress": null,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    },
    {
      "FlowInstanceId": 300100119291286,
      "BaseFlowId": 100000021552103,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "IN_PROGRESS",
      "InstanceName": "soap_auto_trigger action retry",
      "AttributeCategory": null,
      "Errored": null,
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": null,
      "FiProcessDate": null,
      "FiRolledback": null,
      "FiTaskFlowFlag": null,
      "FiTaskStatus": null,
      "FiTaskType": null,
      "FiTotalCompleted": null,
      "InstantiatedBy": "126",
      "MarkedForRetry": null,
      "NumberOfTasks": null,
      "Progress": 100,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    },
    {
      "FlowInstanceId": 300100119126453,
      "BaseFlowId": 100000021552103,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "COMPLETED",
      "InstanceName": "soap_auto_trigger action mark for retry",
      "AttributeCategory": null,
      "Errored": null,
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": null,
      "FiProcessDate": null,
      "FiRolledback": null,
      "FiTaskFlowFlag": null,
      "FiTaskStatus": null,
      "FiTaskType": null,
      "FiTotalCompleted": null,
      "InstantiatedBy": "126",
      "MarkedForRetry": null,
      "NumberOfTasks": null,
      "Progress": 100,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    },
    {
      "FlowInstanceId": 300100075141170,
      "BaseFlowId": 100000021552078,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "IN_PROGRESS",
      "InstanceName": "Adnan Test 1",
      "AttributeCategory": null,
      "Errored": null,
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": null,
      "FiProcessDate": null,
      "FiRolledback": null,
      "FiTaskFlowFlag": null,
      "FiTaskStatus": null,
      "FiTaskType": null,
      "FiTotalCompleted": null,
      "InstantiatedBy": "100100013555209",
      "MarkedForRetry": null,
      "NumberOfTasks": null,
      "Progress": null,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    },
    {
      "FlowInstanceId": 300100069469168,
      "BaseFlowId": 300100028325223,
      "LegislativeDataGroupId": 300100037952462,
      "Status": "COMPLETED",
      "InstanceName": "tyytty",
      "AttributeCategory": null,
      "Errored": null,
      "ExecutionMode": null,
      "FiCompletedTasks": null,
      "FiPayrollId": null,
      "FiProcessDate": null,
      "FiRolledback": null,
      "FiTaskFlowFlag": null,
      "FiTaskStatus": null,
      "FiTaskType": null,
      "FiTotalCompleted": null,
      "InstantiatedBy": "100100013555209",
      "MarkedForRetry": null,
      "NumberOfTasks": null,
      "Progress": 50,
      "RecurSchFormulaId": -1,
      "RecurSchTimeDefId": null,
      "RecurTimeComponent": null,
      "RecurringFlag": false,
      "Reversed": null,
      "RootFlowInstanceId": null,
      "RunId": null,
      "ScheduleEndDate": null,
      "ScheduledDate": null,
      "links": []
    }
  ],
  "count": 7,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
     {
       ...]
}
Back to Top