1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Flow Instances

Get all payroll flow instances

get

/hcmRestApi/resources/11.13.18.05/flowInstances

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 the payroll flow names that match the specified primary key criteria.
      Finder Variables
      • FlowInstanceId; integer; Unique identifier for the payroll flow used to retrieve the payroll flow record.
    • findByStatus Finds payroll flow instances based on the status.
      Finder Variables
      • Status; string; Calculated status for a flow instance with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors, and NULL for Task Flow flow instances type.
  • 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:
    • BaseFlowId; integer; Unique identifier for the flow pattern with which the submitted flow instance is associated.
    • CompletedTasks; integer; Number of flow tasks completed in a flow instance.
    • CreatedBy; string; User who created the flow instance information.
    • CreationDate; string; Date and time when the flow instance information was created.
    • FlowInstanceId; integer; Unique identifier used to retrieve the submitted flow instance.
    • FlowName; string; Unique name for a flow instance within a legislation.
    • GroupStatus; string; High level status of a flow instance, such as Completed with error, without mentioning the specifics of the error.
    • IsDataLoader; string; Indicates whether a flow instance has a data loader type of task. The valid values are Y, N, and Null. The default value is N.
    • IsExtract; string; Indicates whether a flow instance has an extract type of task. The valid values are Y, N, and Null. The default value is N.
    • LastUpdateDate; string; Date and time when the flow instance information was last updated.
    • LastUpdatedBy; string; User who last updated the flow instance information.
    • LegislativeDataGroupId; integer; Unique identifier for the legislative data group used to retrieve the payroll flow instance.
    • NumberOfTasks; integer; Count of the total tasks in a task flow.
    • PayrollId; integer; Unique identifier for the payroll that's passed as a parameter to the flow instance.
    • ProcessDate; string; Process date passed as a parameter to the flow instance.
    • Records; number; Number of individual records successfully completed in a flow instance for a standard process.
    • RecurSchFormulaId; integer; Unique identifier of the fast formula used for scheduling a flow.
    • RecurringFlag; boolean; Indicates whether the flow instance that's being processed belongs to the flow instance that was submitted on a recurring basis. The valid values are True and False. The default value is False.
    • RootFlowInstanceId; integer; Unique identifier for the first flow instance of the recurring schedule.
    • ScheduleEndDate; string; Date that indicates the end of a recurring schedule.
    • ScheduledDate; string; Date that indicates the start of a recurring schedule.
    • Status; string; Calculated status for a flow instance with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors, and NULL for Task Flow type of flow instances.
    • TaskType; string; Task type of a flow instance, such as process, report, or task flow.
  • 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 : flowInstances
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : flowInstances-item-response
Type: object
Show Source
Nested Schema : Checklists
Type: array
Title: Checklists
The checklists resource is a child of the flowInstances resource and provides a list of all the tasks and actions from a submitted payroll flow.
Show Source
Nested Schema : flowInstances-checklists-item-response
Type: object
Show Source
  • Unique identifier for the flow task.
  • Read Only: true
    Maximum Length: 250
    Name of the checklist.
  • Read Only: true
    Maximum Length: 64
    User who created the checklist information.
  • Read Only: true
    Date and time when the checklist information was created.
  • Read Only: true
    Unique identifier used to retrieve the submitted flow instance.
  • Unique identifier to identify a submitted flow task instance.
  • Read Only: true
    Maximum Length: 255
    High level status of a checklist, such as Completed with error, without mentioning the specifics of the error.
  • Maximum Length: 2
    Indicates whether the process is being canceled in the background. Valid values are Y and N. The default value is N.
  • Read Only: true
    Date and time when the checklist information was last updated.
  • Read Only: true
    Maximum Length: 64
    User who last updated the checklist information.
  • Links
  • Maximum Length: 80
    Option that indicates whether a process is submitted with logging enabled.
  • Read Only: true
    Maximum Length: 4000
    Unique identifier to identify a checklist owner.
  • Read Only: true
    Maximum Length: 18
    Type of a group or a single checklist owner.
  • Number of individual records successfully completed in a flow instance for a standard process.
  • Read Only: true
    Maximum Length: 255
    Calculated status for a checklist with valid values, such as PROCESSING for Processing, C_ERRORS for Critical Errors, STOPPED for Stopped, COMPLETED for Completed, ROLLEDBACK for Full Rollback, IS_ROLLEDBACK for Rolled Back Records, IS_MFR for Marked for Retry, INCOMPLETE for Incomplete, SKIPPED for Skipped, NOT_STARTED for Not Started, CANCELED for Canceled, SCHEDULED for Scheduled, ERRORS for Errors.
Back to Top

Examples

The following examples show how to get payroll instances by submitting a GET request on the REST resource using cURL.

Get All Instances

In this example, a GET operation is performed on the resource to get all the flow instances.

curl -i -u "<username>:<password>" -H Content-Type: application/vnd.oracle.adf.resourceitem+json -X GET https://host:port/hcmRestApi/resources/11.13.18.05/flowInstances

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" : 300100003409380,
    "RootFlowInstanceId" : null,
    "FlowName" : "ZPAY_GPGB_COST_Payroll_Jan2011",
    "LegislativeDataGroupId" : 100000012473339,
    "BaseFlowId" : 100000021552103,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : null,
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "ZPAY_PAYROLL_MANAGER_TAKUR",
    "CreationDate" : "2011-12-01T05:17:21+00:00",
    "RecurSchFormulaId" : null,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : null,
    "Records" : null,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "ZPAY_PAYROLL_MANAGER_TAKUR",
    "LastUpdateDate" : "2011-12-01T05:18:04+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100003341349,
    "RootFlowInstanceId" : null,
    "FlowName" : "RB_BatPayroll",
    "LegislativeDataGroupId" : 300100001794245,
    "BaseFlowId" : 100000021552115,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : null,
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "PAY_MGR_ALL",
    "CreationDate" : "2011-11-30T23:11:48.442+00:00",
    "RecurSchFormulaId" : null,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : null,
    "Records" : null,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "PAY_MGR_ALL",
    "LastUpdateDate" : "2011-11-30T23:12:20+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100003428488,
    "RootFlowInstanceId" : null,
    "FlowName" : "ZPAY_GPGB_COST_Retro_012011",
    "LegislativeDataGroupId" : 100000012473339,
    "BaseFlowId" : 100000021552112,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : null,
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "ZPAY_PAYROLL_MANAGER_TAKUR",
    "CreationDate" : "2011-12-01T05:51:36.483+00:00",
    "RecurSchFormulaId" : null,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : null,
    "Records" : null,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "ZPAY_PAYROLL_MANAGER_TAKUR",
    "LastUpdateDate" : "2011-12-01T05:51:58+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100003452124,
    "RootFlowInstanceId" : null,
    "FlowName" : "BatCompile2",
    "LegislativeDataGroupId" : 300100001794245,
    "BaseFlowId" : 100000021552078,
    "GroupStatus" : "IN_PROGRESS",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : null,
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "PAY_MGR_ALL",
    "CreationDate" : "2011-12-01T06:15:13.297+00:00",
    "RecurSchFormulaId" : null,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : null,
    "Records" : null,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "PAY_MGR_ALL",
    "LastUpdateDate" : "2011-12-01T06:15:14+00:00",
    "Status" : "PROCESSING",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100004960379,
    "RootFlowInstanceId" : null,
    "FlowName" : "RRF_Run1",
    "LegislativeDataGroupId" : 300100001794246,
    "BaseFlowId" : 100000021552103,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : null,
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "PAY_MGR_ALL",
    "CreationDate" : "2011-12-01T22:42:24.622+00:00",
    "RecurSchFormulaId" : null,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : null,
    "Records" : null,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "PAY_MGR_ALL",
    "LastUpdateDate" : "2011-12-01T22:43:06+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}
    ]
}

Use a Finder

In this example, the finder findByStatus is used with the finder variable Status to get all the flow instances that match the specified status completed criteria. The following is an example of the cURL command. 

curl -i -u "<username>:<password>" -H Content-Type: appliation/vnd.oracle.adf.resourceitem+json -X GET "https://host:port/hcmRestApi/resources/11.13.18.05/flowInstances?finder=findByStatus;Status=COMPLETED"

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" : 300100185843247,
    "RootFlowInstanceId" : null,
    "FlowName" : "ZHRX_CA_EOY_ARCHIVE_CANLE_2019",
    "LegislativeDataGroupId" : 300100072150859,
    "BaseFlowId" : 100000021552089,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : "PROCESS",
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "hcm.user@example.com",
    "CreationDate" : "2019-12-11T18:33:37+00:00",
    "RecurSchFormulaId" : -1,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : false,
    "Records" : 0,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "hcm.user@example.com",
    "LastUpdateDate" : "2019-12-11T18:34:37.123+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100186304660,
    "RootFlowInstanceId" : null,
    "FlowName" : "CalcPAy_022019Suppl",
    "LegislativeDataGroupId" : 300100025776039,
    "BaseFlowId" : 100000021552103,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : "PROCESS",
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "hcm.user@example.com",
    "CreationDate" : "2019-12-12T07:46:46+00:00",
    "RecurSchFormulaId" : -1,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : false,
    "Records" : 0,
    "PayrollId" : 300100185294001,
    "ProcessDate" : "2019-02-01",
    "LastUpdatedBy" : "hcm.user@example.com",
    "LastUpdateDate" : "2019-12-12T09:18:22.374+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100186799250,
    "RootFlowInstanceId" : null,
    "FlowName" : "SSNP_TP_PAYROLL 2_TPP_ROLLUP_1/1/19",
    "LegislativeDataGroupId" : 300100025776039,
    "BaseFlowId" : 300100050765517,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : "PROCESS",
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "hcm.user@example.com",
    "CreationDate" : "2019-12-12T08:46:36+00:00",
    "RecurSchFormulaId" : -1,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : false,
    "Records" : 0,
    "PayrollId" : 300100095388265,
    "ProcessDate" : "2019-01-31",
    "LastUpdatedBy" : "hcm.user@example.com",
    "LastUpdateDate" : "2019-12-12T08:47:05.837+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}   
  },
  {
    "FlowInstanceId" : 300100182736800,
    "RootFlowInstanceId" : null,
    "FlowName" : "RD Message Check 002",
    "LegislativeDataGroupId" : 300100025776039,
    "BaseFlowId" : 100000021552103,
    "GroupStatus" : "COMPLETED",
    "IsExtract" : null,
    "IsDataLoader" : null,
    "TaskType" : null,
    "NumberOfTasks" : null,
    "CompletedTasks" : null,
    "CreatedBy" : "hcm.user@example.com",
    "CreationDate" : "2019-09-08T15:58:23+00:00",
    "RecurSchFormulaId" : -1,
    "ScheduledDate" : null,
    "ScheduleEndDate" : null,
    "RecurringFlag" : false,
    "Records" : 0,
    "PayrollId" : null,
    "ProcessDate" : null,
    "LastUpdatedBy" : "PAY_MGR_ALL",
    "LastUpdateDate" : "2022-01-03T16:46:39.983+00:00",
    "Status" : "COMPLETED",
    "links" : [ 
        {
           ...}
    ]
}
Back to Top