Jump to

• Request
• Response

Perform action on communication message

post

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

Performs an action, such as Approve or Reject, on a communication message and saves any related comments and attachments included in the request payload.

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

  Identifiers and action details for performing an action on a communication message.
• attachments: array attachments
  Attachment details to be stored and associated with the communication message as part of performing the action.

{
    "type":"object",
    "properties":{
        "attachments":{
            "type":"array",
            "description":"Attachment details to be stored and associated with the communication message as part of performing the action.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "actionParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Identifiers and action details for performing an action on a communication message.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : actionParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Identifiers and action details for performing an action on a communication message.",
    "nullable":true
}

Identifiers and action details for performing an action on a communication message.

Nested Schema : attachments

Type: array

Attachment details to be stored and associated with the communication message as part of performing the action.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Attachment details to be stored and associated with the communication message as part of performing the action.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

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

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 success when the action is processed without issues, otherwise provides detailed error messages.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns success when the action is processed without issues, otherwise provides detailed error messages."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns success when the action is processed without issues, otherwise provides detailed error messages."
}

Returns success when the action is processed without issues, otherwise provides detailed error messages.

Back to Top