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

Get all omnichannel events

get

/crmRestApi/resources/11.13.18.05/omniChannelEvents

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

    • PrimaryKey The unique identifier of the omnichannel event.
      Finder Variables
      • EventId; integer; Finds an omnichannel event with the specified primary key.
  • 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:
    • BuOrgId; integer; The unique identifier of the Business Unit Organization associated with the work object of the omnichannel event.
    • ChannelId; integer; The unique identifier of the channel associated to the work object omnichannel event.
    • ChannelTypeCd; string; The code indicating the channel type. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
    • ContactPartyId; integer; The unique identifier of the contact party associated with the work object omnichannel event.
    • CreatedBy; string; The user who created the omnichannel event.
    • CreationDate; string; The date and time when the omnichannel event was created.
    • DurationMs; integer; The difference between the omnichannel event end time and start time in milliseconds.
    • EndDateTrunc; string; A representation of the omnichannel event end time truncated to the day.
    • EndTime; string; The time that this omnichannel event ended.
    • EventId; integer; The unique identifier of the omnichannel event.
    • EventNameCd; string; The lookup code that indicates the name of the event.
    • InteractionId; integer; The unique identifier of the interaction associated to the work object omnichannel event.
    • LastUpdateDate; string; The date and time when the omnichannel event was last updated.
    • LastUpdateLogin; string; The user who last updated the omnichannel event.
    • LastUpdatedBy; string; The login of the user who last updated the omnichannel event.
    • ObjectId; string; The unique identifier of the business object or client channel instance identifier associated with the omnichannel event.
    • ObjectTypeCd; string; The type of the business object associated to the event such as SVC_SERVICE_REQUESTS.
    • Priority; integer; The priority of the business object associated to the event. For example a SR's priority could be calculated based on its severity.
    • QueueId; integer; The identifier of the queue assigned to the work object associated with the omnichannel event.
    • ResourcePartyId; integer; The identifier of the resource assigned to the work object associated to the omnichannel event.
    • StartDateTrunc; string; A representation of the omnichannel event start time truncated to the day.
    • StartTime; string; The time the omnichannel event occurred or when it started.
    • StripeCd; string; The lookup code that indicates the work object stripe code, such as ORA_SVC_CRM or ORA_SVC_HCM.
    • SubmitDateTrunc; string; The date the underlying work object was submitted truncated to the day.
    • SubmitTime; string; The time that the underlying work object was submitted.
    • Value; string; A value associated with the omnichannel event. The meaning of the value is event specific.
    • WorkObjectId; integer; The unique identifier of the work object associated to the omnichannel event.
  • 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 : omniChannelEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : omniChannelEvents-item-response
Type: object
Show Source
Back to Top