Jump to

• Request
• Response

Perform action on a transaction

post

/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performCommunicationAction

Performs actions that are applicable to a particular task.

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

• actionParams: object actionParams
  Additional Properties Allowed: additionalProperties

  Actions to perform on the task.

{
    "type":"object",
    "properties":{
        "actionParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Actions to perform on the task.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : actionParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Actions to perform on the task.",
    "nullable":true
}

Actions to perform on the task.

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

  Success or error message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Success or error message."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Success or error message."
}

Success or error message.

Back to Top