Jump to

• Request
• Response

Retrieve communication notification details

post

/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getCommunicationNotificationDetails

Retrieves communication notification details using the provided inputs such as communication ID or message ID.

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

• communicationNotificationParams: object communicationNotificationParams
  Additional Properties Allowed: additionalProperties

  Input parameter for retrieving communication notification details.

{
    "type":"object",
    "properties":{
        "communicationNotificationParams":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Input parameter for retrieving communication notification details.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : communicationNotificationParams

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Input parameter for retrieving communication notification details.",
    "nullable":true
}

Input parameter for retrieving communication notification details.

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 a map containing communication notification details.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns a map containing communication notification details."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns a map containing communication notification details."
}

Returns a map containing communication notification details.

Back to Top