1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Multi Channel Adapter Events

Get all events

get

/crmRestApi/resources/11.13.18.05/multiChannelAdapterEvents

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • AltKey_McaEventNumber: Finds an event with the specified public unique identifier.
      Finder Variables:
      • McaEventNumber; string; The public unique identifier of the event.
    • PrimaryKey: Finds an event with the specified primary key.
      Finder Variables:
      • McaEventId; integer; The unique identifier of the event.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AgentId; integer; The agent identifier from the parties entity.
    • ApplClassificationCd; string; The code of the application classification to which this event applies.
    • BoEntityId; integer; The auto-generated number and primary key for the business object entity table.
    • ChannelId; integer; The auto-generated number and primary key of the channels table.
    • CommId; string; The communication ID represented by the API Event ID.
    • ContactId; integer; The auto-generated number and primary key for the contact table.
    • CreatedBy; string; The user who created the event.
    • CreationDate; string; The date and time when the event was created.
    • DirectionCd; string; The direction of the event for the token values.
    • EntityName; string; A unique identifier of the business object entity.
    • ErrorMsg; string; The error message of the event processing.
    • ErrorMsgCd; string; The error code for the event processing.
    • InTokens; string; The input tokens of the request payload.
    • InteractionId; integer; The auto-generated number and primary key for the interactions table.
    • LastUpdateDate; string; The user who last updated the event.
    • LastUpdateLogin; string; The login of the user who last updated the event.
    • LastUpdatedBy; string; The date when the event was last updated.
    • McaEventId; integer; The auto-generated number and primary key for the event.
    • McaEventNumber; string; The public surrogate key which is required during creation of the row.
    • Method; string; The name of the calling event method.
    • NextState; string; The next state calculated by the event processing.
    • ObjectVersionNumber; integer; The object version number is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
    • Origin; string; The URL representing the event initiator.
    • OutTokens; string; The output tokens in the response payload.
    • Result; string; The returned result of event processing.
    • ToolbarId; integer; The auto-generated number and primary key for the toolbars table.
    • ToolbarName; string; The toolbar name being used for this event.
    • Uuid; string; Client response unique identifier.
    • Version; string; The version of the client side consumer.
    • WindowName; string; The client window identifier of the event.
    • WrapupId; integer; The auto-generated number and primary key for the wrap ups table.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : multiChannelAdapterEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : multiChannelAdapterEvents-item-response
Type: object
Show Source
Links
fetchUserEventConfiguration
Fetches the toolbar configuration for the current user used to process multi-channel adapter events. Information being fetched includes values for debugMode, faTrustToken, AGENT_CONFIG_DATA, agentPartyId, agentId, profileMcaDisableJwt, NLS_LANG, and NLS_LOCALE
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.
Back to Top