Perform a corrective action
post
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/action/performAction
Performs the actual corrective action for a payroll flow.
Request
Path Parameters
-
FlowInstanceId(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:
Show Source
object
-
actionName: string
Name of the corrective action to be performed.
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:
Show Source
object
-
result(required): boolean
Status of the custom method.
Examples
The following example shows how to perform a corrective action on a flow instance by submitting a POST request on the REST resource using cURL.
This example covers the Rollback All
action. Similalrily other available actions can also be performed.
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/flowInstances/300100185843247/action/performAction"
Example of Payload
The following is an example of the payload.
{
"actionName":"ORA_BULK_ROLLBACK"
}
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" : "true"
}