Jump to

• Request
• Response
• Examples

Get corrective actions for a checklist

post

/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}/action/getAvailableActions

Provides the list of corrective action codes and meanings for actions that can be performed for a specified checklist.

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=
• FlowTaskInstanceId(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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Available action codes and meanings for the corrective action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Available action codes and meanings for the corrective action."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Available action codes and meanings for the corrective action."
}

Available action codes and meanings for the corrective action.

Back to Top

Examples

The following example shows how to retrieve the available actions for a checklist by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-type: application/vnd.oracle.adf.action+json" -X POST  "https://host:port/hcmRestApi/resources/11.13.18.05/flowInstances/300100185843247/child/checklists/300100185843250/action/getAvailableActions"

Example of Response Header

The following is an example of the response header.

Status: 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" : {
    "ORA_SKIP_FLOW_TASK_INSTANCE": "Skip Task",
    "ORA_SUBMIT": "Submit",
    "ORA_CHANGE_OWNER": "Change Owner"
  }
}

Back to Top