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

Get all flow patterns

get

/hcmRestApi/resources/11.13.18.05/flowPatterns

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

    • FindFlowsByLDG Finds payroll flows where the Legislative Data Group Required Flag is either Y or B and the flow either belongs to the users legislation or a global record.
      Finder Variables
      • LegislativeDataGroupId; integer; Legislative Data Group identifier passed to the finder.
    • PrimaryKey Finds the payroll flow pattern that matches the primary key criteria specified.
      Finder Variables
      • FlowId; integer; Unique identifier for the payroll flow pattern used to retrieve the payroll flow record.
  • 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 from which the flow pattern is inherited.
    • BaseFlowName; string; Code that uniquely identifies the flow pattern.
    • ConnectorName; string; User defined connector tag which is used to consolidate the results across the processes.
    • ConnectorStatus; string; Status that indicates whether a flow is a task flow or a parameters-only flow pattern.
    • Description; string; Description of the flow pattern.
    • FlowId; integer; Unique identifier used to retrieve the flow pattern.
    • FlowPattern; string; Name of the flow pattern.
    • FlowStatus; string; Status that indicates whether a flow is a task flow or a standalone process and whether it's active or inactive. The valid values are H, D, Y, and N.
    • LDGRequired; string; Indicates whether a legislative data group identifier must be provided when creating a flow instance using the flow pattern. The valid values are Y, B, and N. The default value is Y.
    • LegislationCode; string; Country code, such as GB for UK, for the legislative data group that's used to retrieve values for a flow pattern.
    • LegislativeDataGroupId; integer; Identifier for the legislative data group associated with the flow pattern.
  • 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 : flowPatterns
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : flowPatterns-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier from which the flow pattern is inherited.
  • Read Only: true
    Maximum Length: 100
    Code that uniquely identifies the flow pattern.
  • Read Only: true
    Maximum Length: 255
    User defined connector tag which is used to consolidate the results across the processes.
  • Read Only: true
    Maximum Length: 255
    Status that indicates whether a flow is a task flow or a parameters-only flow pattern.
  • Read Only: true
    Maximum Length: 250
    Description of the flow pattern.
  • Read Only: true
    Unique identifier used to retrieve the flow pattern.
  • Flow Parameters
    Title: Flow Parameters
    The flowParameters resource is the child of the flowPatterns resource and provides the ability to define and maintain user-defined payroll flows.
  • Title: Flow Pattern
    Read Only: true
    Maximum Length: 250
    Name of the flow pattern.
  • Read Only: true
    Maximum Length: 255
    Status that indicates whether a flow is a task flow or a standalone process and whether it's active or inactive. The valid values are H, D, Y, and N.
  • Read Only: true
    Maximum Length: 1
    Default Value: Y
    Indicates whether a legislative data group identifier must be provided when creating a flow instance using the flow pattern. The valid values are Y, B, and N. The default value is Y.
  • Read Only: true
    Maximum Length: 30
    Country code, such as GB for UK, for the legislative data group that's used to retrieve values for a flow pattern.
  • Identifier for the legislative data group associated with the flow pattern.
  • Links
Nested Schema : Flow Parameters
Type: array
Title: Flow Parameters
The flowParameters resource is the child of the flowPatterns resource and provides the ability to define and maintain user-defined payroll flows.
Show Source
Nested Schema : flowPatterns-flowParameters-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier from which the flow pattern is inherited.
  • Read Only: true
    Unique identifier from which the flow parameter is inherited.
  • Read Only: true
    Maximum Length: 100
    Code that uniquely identifies the flow parameter.
  • Read Only: true
    Maximum Length: 2000
    Identifier for the default value for a given flow parameter for the corresponding default type, for example an SQL query for default type POST_SQL and SQL, a constant value like CONST, a context value like FTI, LDGID SYSDATE for the default type as BIND_CONTEXT, a flow parameter ID for default type as BIND_FLOW, a flow task parameter ID for default type BIND_FLOW_TASK.
  • Title: Description
    Read Only: true
    Maximum Length: 250
    Description of the flow parameter.
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether a parameter should be displayed for a flow pattern. The valid values are Y for Yes, M for Mandatory, and N for No.
  • Read Only: true
    Maximum Length: 30
    Type of a flow parameter. The possible values are UCM for UCM Component, LK for lookups, L choice lists, N for number, LOV for client side list of values, D for date, T for text field and ORA_VALUESET for value sets.
  • Read Only: true
    Maximum Length: 250
    Name of the flow parameter.
  • Read Only: true
    Unique identifier used to retrieve values for a flow parameter.
  • Read Only: true
    Maximum Length: 30
    Country code, such as GB for UK, for the legislative data group that's used to retrieve values for a flow pattern.
  • Read Only: true
    Identifier for the legislative data group associated with the flow pattern.
  • Links
  • Read Only: true
    Maximum Length: 30
    Identifier for the type of defaulting for the parameter. The possible values are, ORA_VALUESET for value sets, BIND_FLOW for using the value from a flow parameter, POST_SQL default for value from a SQL post flow submission, BIND_CONTEXT default context values like FI for flow instance, FTI for flow task instance, LDGID for legislative data group identifiers and SYSDATE for System Date, SQL default for value from a SQL before flow submission and CONST default using a constant value, and BIND_FLOW_TASK for using the value from a flow task parameter.
  • Read Only: true
    Sequence in which parameters are displayed in the flow submission UI.
  • Read Only: true
    Maximum Length: 30
    Option that determines whether a parameter is an input parameter or an output parameter.
Back to Top

Examples

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

Get All Flow Patterns

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

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

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" : [ 
  {
    "FlowId" : 100100075869005,
    "BaseFlowId" : 100100075869005,
    "BaseFlowName" : "123",
    "FlowStatus" : "A",
    "LDGRequired" : "N",
    "LegislationCode" : null,
    "FlowPattern" : "123",
    "Description" : null,
    "LegislativeDataGroupId" : null,
    "ConnectorName" : "123",
    "ConnectorStatus" : "PO",
    "links" : [ 
        {
           ...}   
      ]  
  },
  {
    "FlowId" : 100100465885256,
    "BaseFlowId" : 100100465885256,
    "BaseFlowName" : "AA_123",
    "FlowStatus" : "A",
    "LDGRequired" : "N",
    "LegislationCode" : null,
    "FlowPattern" : "AA_123",
    "Description" : null,
    "LegislativeDataGroupId" : null,
    "ConnectorName" : "AA_123",
    "ConnectorStatus" : "PO",
    "links" : [ {
        {
           ...}
      ] 
  },
  {
    "FlowId" : 100100465889918,
    "BaseFlowId" : 100100465889918,
    "BaseFlowName" : "AA_234",
    "FlowStatus" : "A",
    "LDGRequired" : "N",
    "LegislationCode" : null,
    "FlowPattern" : "AA_234",
    "Description" : null,
    "LegislativeDataGroupId" : null,
    "ConnectorName" : "AA_234",
    "ConnectorStatus" : "PO",
    "links" : [ { 
        {
           ...}   
      ]
  },
  {
    "FlowId" : 100100478903188,
    "BaseFlowId" : 100100478903188,
    "BaseFlowName" : "AA_234_LDG",
    "FlowStatus" : "A",
    "LDGRequired" : "Y",
    "LegislationCode" : null,
    "FlowPattern" : "AA_234_LDG",
    "Description" : null,
    "LegislativeDataGroupId" : 300100009870811,
    "ConnectorName" : "AA_234_LDG",
    "ConnectorStatus" : "PO",
    "links" : [ 
        {
           ...}   
      ]  
  },
  {
    "FlowId" : 100100479464069,
    "BaseFlowId" : 100100479464069,
    "BaseFlowName" : "AA_Benefits_ Ext",
    "FlowStatus" : "A",
    "LDGRequired" : "N",
    "LegislationCode" : null,
    "FlowPattern" : "AA_Benefits_ Ext",
    "Description" : null,
    "LegislativeDataGroupId" : null,
    "ConnectorName" : "AA_Benefits_ Ext",
    "ConnectorStatus" : "PO",

    "links" : [ 
        {
           ...}   
      ]  
  }
]
}

Get Flow Patterns Using a Finder and a Finder Variable

In this example, the finder FindFlowsByLDG is used with the finder variable LegislativeDataGroupId to get all the flow patterns that match the specified compile formula flow pattern criteria. The following is an example of the cURL command. 

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/flowPatterns?finder=FindFlowsByLDG;LegislativeDataGroupId=300100007803368&q=FlowPattern=%22Compile%20Formula%22"

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" : [ 
 {
  "FlowId" : 100000021552078,
  "BaseFlowId" : 100000021552078,
  "BaseFlowName" : "COMPILE_FORMULA",
  "FlowStatus" : "A",
  "LDGRequired" : "Y",
  "LegislationCode" : null,
  "FlowPattern" : "Compile Formula",
  "Description" : "Submit a process to compile fast formulas. All fast formulas must be compiled before executing them in calculations.",
  "LegislativeDataGroupId" : null,
  "ConnectorName" : "COMPILE_FORMULA",
  "ConnectorStatus" : "PO",
  "links" : [ 
        {
           ...}
    ]
 }
]
}

Get Flow Patterns Using a Finder and a NULL Finder Variable

In this example, the finder FindFlowsByLDG is used with the finder variable LegislativeDataGroupId set to NULL to get all the flow patterns loaded from the file. The following is an example of the cURL command. 

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/flowPatterns?finder=FindFlowsByLDG;LegislativeDataGroupId=&q=FlowPattern=%22Load%20Data%20from%20File%22"

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" : [ 
 {
  "FlowId" : 100100121294472,
  "BaseFlowId" : 100100121294472,
  "BaseFlowName" : "ORA_LOAD_HDL_FROM_FILE",
  "FlowStatus" : "A",
  "LDGRequired" : "B",
  "LegislationCode" : null,
  "FlowPattern" : "Load Data from File",
  "Description" : "Submit a flow to transform and submit a file from the Oracle Web Center Content server using HCM Data Loader.",
  "LegislativeDataGroupId" : null,
  "ConnectorName" : "ORA_LOAD_HDL_FROM_FILE",
  "ConnectorStatus" : "TF",
  "links" : [ 
        {
           ...}
     ]
 }
]
}
Back to Top