Jump to

• Request
• Response

Process communication records

post

/fscmRestApi/resources/11.13.18.05/communicationHistories/action/processCommunications

Triggers the processing of communications, after it receives the event payload. For example, event payload contains data of multiple recipients, and will result in multiple communication records being created. This method itself doesn't create the communication records, but runs the scheduled processes for creating them.

Request

Header Parameters

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

• Payload: string
  Contains data of multiple recipients.

{
    "type":"object",
    "properties":{
        "Payload":{
            "type":"string",
            "description":"Contains data of multiple recipients.",
            "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): string
  Returns job IDs for the scheduled processes.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns job IDs for the scheduled processes."
        }
    },
    "additionalProperties":false
}

Back to Top