Jump to

• Request
• Response

Retrieve the list of task actions

post

/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getActionsMap

Retrieves the list of task actions based on the specified task identifier or transaction 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 fetch the list of actions permissible for the logged-in user.
• taskId: string
  Task identifier associated with the user of the submitted transaction.
• transactionId: number
  Identifier for the transaction used to fetch the list of actions permissible for the logged-in user.

{
    "type":"object",
    "properties":{
        "identificationKey":{
            "type":"string",
            "description":"Identifier for the task used to fetch the list of actions permissible for the logged-in user.",
            "nullable":true
        },
        "taskId":{
            "type":"string",
            "description":"Task identifier associated with the user of the submitted transaction.",
            "nullable":true
        },
        "transactionId":{
            "type":"number",
            "description":"Identifier for the transaction used to fetch the list of actions permissible for the logged-in user.",
            "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

  Returns list of actions along with basic details.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Returns list of actions along with basic details."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Returns list of actions along with basic details."
}

Returns list of actions along with basic details.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top