Jump to

• Request
• Response

Retrieve the list of actions

post

/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getActionsBasedOnIdentificationKey

Retrieves the list of actions that can be performed on the task based on the identifier.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

Show Source

• identificationKey: string
  Identifier for the task used to retrieve the list of actions.
• transactionId: number
  Identifier for the transaction associated to the user who submitted the transaction.

{
    "type":"object",
    "properties":{
        "identificationKey":{
            "type":"string",
            "description":"Identifier for the task used to retrieve the list of actions.",
            "nullable":true
        },
        "transactionId":{
            "type":"number",
            "description":"Identifier for the transaction associated to the user who submitted the transaction.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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

  Internal identifier for the task based on which actions are returned.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Internal identifier for the task based on which actions are returned."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Internal identifier for the task based on which actions are returned."
}

Internal identifier for the task based on which actions are returned.

Back to Top