Jump to

• Request
• Response

Process an engagement event for an assignable business object or chat asynchronously

post

/crmRestApi/resources/11.13.18.05/universalWorkObjects/action/processEngagementEvent

This method processes the engagement event for routing a business object or chat asynchronously. It assigns a queue or agent if needed, creates internal events to track routing history, and creates interactions for customer communications.

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

• data: string
  Process an engagement event received as a JSON string for the assignable business object or chat asynchronously.

{
    "type":"object",
    "properties":{
        "data":{
            "type":"string",
            "description":"Process an engagement event received as a JSON string for the assignable business object or chat asynchronously.",
            "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
  Process an engagement event for the assignable business object or chat asynchronously and return the response code immediately after data validation.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Process an engagement event for the assignable business object or chat asynchronously and return the response code immediately after data validation."
        }
    },
    "additionalProperties":false
}

Back to Top