REST API for Oracle Fusion Cloud HCM

Submit a flow

post

/hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}/action/submitFlow

Submits a flow with the supplied parameters and their values.

Request

Path Parameters

FlowId(required): integer(int64)

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=

Header Parameters

Metadata-Context:

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".
REST-Framework-Version:

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.

Supported Media Types

application/vnd.oracle.adf.action+json

Root Schema : schema

Type: object

Show Source

crossFlowInteractionList: array crossFlowInteractionList

List containing flow instance identifiers and flow task identifiers to create cross flow interactions.
flowInstanceName: string

Unique name for a flow instance within a legislation.
legislativeDataGroupId: number

Unique identifier for the legislative data group used to submit the flow.
parameterIdValues: object parameterIdValues

Additional Properties Allowed: additionalProperties

Map containing flow parameter identifiers and their values.
scheduleEndTime: string (date-time)

Timestamp that indicates the end of a recurring schedule.
scheduleFormulaName: string

Formula name for scheduling the submission of the flow.
scheduleStartTime: string (date-time)

Timestamp that indicates the start of a recurring schedule.

{
    "type":"object",
    "properties":{
        "crossFlowInteractionList":{
            "type":"array",
            "description":"List containing flow instance identifiers and flow task identifiers to create cross flow interactions.",
            "nullable":true,
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "scheduleFormulaName":{
            "type":"string",
            "description":"Formula name for scheduling the submission of the flow.",
            "nullable":true
        },
        "legislativeDataGroupId":{
            "type":"number",
            "description":"Unique identifier for the legislative data group used to submit the flow.",
            "nullable":true
        },
        "flowInstanceName":{
            "type":"string",
            "description":"Unique name for a flow instance within a legislation.",
            "nullable":true
        },
        "parameterIdValues":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Map containing flow parameter identifiers and their values.",
            "nullable":true
        },
        "scheduleStartTime":{
            "type":"string",
            "description":"Timestamp that indicates the start of a recurring schedule.",
            "format":"date-time",
            "nullable":true
        },
        "scheduleEndTime":{
            "type":"string",
            "description":"Timestamp that indicates the end of a recurring schedule.",
            "format":"date-time",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : crossFlowInteractionList

Type: array

List containing flow instance identifiers and flow task identifiers to create cross flow interactions.

Show Source

Array of: array items

{
    "type":"array",
    "description":"List containing flow instance identifiers and flow task identifiers to create cross flow interactions.",
    "nullable":true,
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterIdValues

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Map containing flow parameter identifiers and their values.",
    "nullable":true
}

Map containing flow parameter identifiers and their values.

Nested Schema : items

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json
application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Root Schema : schema

Type: object

Show Source

result(required): number

Flow instance identifier.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"number",
            "description":"Flow instance identifier."
        }
    },
    "additionalProperties":false
}

Examples

The following examples show how to submit a payroll flow pattern by submitting a POST request on the REST resource using cURL.

Submit a Flow Pattern without a Schedule

In this example, a POST operation is performed to submit a flow for the Load Data from File flow pattern without a schedule.

You can obtain the flow parameter details by performing GET action on the flowParameterValuesLOV REST resource using the flowparameterId.

curl -i -u "<username>:<password>" -H "Content-type: application/vnd.oracle.adf.action+json" -d <payload> -X POST  "https://host:port/hcmRestApi/resources/11.13.18.05/flowPatterns/100100121294472/action/submitFlow"

Example of Payload

The following is an example of the payload.

{
  "parameterIdValues": {
                         "100100121322883":"UCMFA00058412",
                         "100100121322881":"300100181568962"
                       },
  "flowInstanceName": "ABC_TC3"
}

Example of Response Header

The following is an example of the response header.

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

Example of Response Body

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

{
  "result" : "300100626346624"
}

Submit a Flow Pattern with a Schedule of Single Execution

In this example, a POST operation is performed to submit a flow for the Load Data from File flow pattern with the schedule of running it once in the future.

curl -i -u "<username>:<password>" -H "Content-type: application/vnd.oracle.adf.action+json" -d <payload> -X POST  "https://host:port/hcmRestApi/resources/11.13.18.05/flowPatterns/100100121294472/action/submitFlow"

Example of Payload

The following is an example of the payload.

{
  "parameterIdValues": {
                         "100100121322883":"UCMFA00058412",
                         "100100121322881":"300100181568962"
                       },
  "flowInstanceName": "ABC_TC_SCH_ROF_1",
  "scheduleStartTime": "2021-09-01 09:01:16"
}

Example of Response Header

The following is an example of the response header.

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

Example of Response Body

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

{
  "result" : "300100626422175"
}

Submit a Flow Pattern with a Schedule of Recurring Executions

In this example, a POST operation is performed to submit a flow for the Load Data from File flow pattern with the schedule of recurring executions in the future.

curl -i -u "<username>:<password>" -H "Content-type: application/vnd.oracle.adf.action+json" -d <payload> -X POST  "https://host:port/hcmRestApi/resources/11.13.18.05/flowPatterns/100100121294472/action/submitFlow"

Example of Payload

The following is an example of the payload.

{
  "parameterIdValues": {
                         "100100121322883":"UCMFA00058412",
                         "100100121322881":"300100181568962"    
                       },
  "flowInstanceName": "ABC_TC_SCH_RCF_1"
  "scheduleFormulaName": "Daily",
  "scheduleStartTime": "2021-06-15 09:01:16",
  "scheduleEndTime": "2021-06-17 11:01:16"
}

Example of Response Header

The following is an example of the response header.

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

Example of Response Body

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

{
  "result" : "300100626435610"
}

Submit a Flow Pattern with Cross-flow Interactions

In this example, a POST operation is performed a flow for the Load Data from File flow pattern with cross-flow interactions having the fromFlowInstance same as the submitted flow.

Note:

The crossFlowInteractionListcontains a list wthin a list. The list includes:

 ["fromFlowInstanceId","fromFlowTaskId","toFlowInstanceId","toFlowTaskId","impactCalculationFlag","ignoreErrorsFlag"]

The fromflowInstanceId and toFlowInstanceId details can be obtained from the flowInstances REST resource
The fromFlowTaskId and toFlowtaskId details can be obtained from Checklist REST resource

curl -i -u "<username>:<password>" -H "Content-type: application/vnd.oracle.adf.action+json" -d <payload> -X POST  "https://host:port/hcmRestApi/resources/11.13.18.05/flowPatterns/100100121294472/action/submitFlow"

Example of Payload

The following is an example of the payload.

{
  "parameterIdValues": {
                         "100100121322883":"UCMFA00058412",
                         "100100121322881":"300100181568962"
                       },
  "flowInstanceName": "ABC_TC_SCH_CRSFI_1",
  "crossFlowInteractionList": [
    [
      "-1",
      "100100121340510",
      "300100559083937",
      "100100121340510",
      "Y",
      "Y"
    ]
  ]
}

Example of Response Header

The following is an example of the response header.

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

Example of Response Body

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

{
  "result" : "300100626448103"
}