Jump to

• Request
• Response

Process a multi-channel adapter event

post

/crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents/action/processEvent

This action accepts a jsonString with the necessary data to process the event request which should include the input tokens. The response of the processed event will include the output tokens and list of applicable actions to take on the client side.

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

• eventName: string
  The name of the event being processed.
• paramsJson: string
  A string representation of a JSON Object which provides the input values for the event process.

{
    "type":"object",
    "properties":{
        "paramsJson":{
            "type":"string",
            "description":"A string representation of a JSON Object which provides the input values for the event process.",
            "nullable":true
        },
        "eventName":{
            "type":"string",
            "description":"The name of the event being processed.",
            "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
  The response of the processed event will include the output tokens and list of applicable actions to take on the client side.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The response of the processed event will include the output tokens and list of applicable actions to take on the client side."
        }
    },
    "additionalProperties":false
}

Back to Top