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

Get a payroll flow instance

get

/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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.
Links
checklists
Parameters:
  • FlowInstanceId: $request.path.FlowInstanceId
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.
getAvailableActions
Parameters:
  • FlowInstanceId: $request.path.FlowInstanceId
Provides the list of corrective action codes and meanings for actions that can be performed for a specified payroll flow.
performAction
Parameters:
  • FlowInstanceId: $request.path.FlowInstanceId
Performs the actual corrective action for a payroll flow.
Back to Top

Examples

The following example shows how to get a payroll flow instance by submitting a GET request on the REST resource using cURL.

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/300100003409380

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.

{
  "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" : [ 
        {
           ...}
    ]
}
Back to Top