Get an omnichannel event
get
/crmRestApi/resources/11.13.18.05/omniChannelEvents/{EventId}
Request
Path Parameters
-
EventId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : omniChannelEvents-item-response
Type:
Show Source
object
-
BuOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the Business Unit Organization associated with the work object of the omnichannel event. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel associated to the work object omnichannel event. -
ChannelTypeCd: string
Title:
Channel
Maximum Length:30
The code indicating the channel type. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ContactPartyId: integer
(int64)
The unique identifier of the contact party associated with the work object omnichannel event.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the omnichannel event. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the omnichannel event was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the omnichannel event can be deleted. -
DurationMs: integer
(int64)
Title:
Duration in Milliseconds
The difference between the omnichannel event end time and start time in milliseconds. -
EndDateTrunc: string
(date)
Title:
End Date Truncated
A representation of the omnichannel event end time truncated to the day. -
EndTime: string
(date-time)
Title:
End Time
The time that this omnichannel event ended. -
EventId: integer
(int64)
Title:
Event ID
Read Only:true
The unique identifier of the omnichannel event. -
EventNameCd: string
Title:
Event Name
Maximum Length:30
The lookup code that indicates the name of the event. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of the interaction associated to the work object omnichannel event. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the omnichannel event was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The login of the user who last updated the omnichannel event. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The user who last updated the omnichannel event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: string
Title:
Object ID
Maximum Length:64
The unique identifier of the business object or client channel instance identifier associated with the omnichannel event. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The type of the business object associated to the event such as SVC_SERVICE_REQUESTS. -
Priority: integer
Title:
Priority
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
(int64)
Title:
Queue ID
The identifier of the queue assigned to the work object associated with the omnichannel event. -
ResourcePartyId: integer
(int64)
Title:
Resource Party ID
The identifier of the resource assigned to the work object associated to the omnichannel event. -
StartDateTrunc: string
(date)
Title:
Start Date Truncated
A representation of the omnichannel event start time truncated to the day. -
StartTime: string
(date-time)
Title:
Start Time
The time the omnichannel event occurred or when it started. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The lookup code that indicates the work object stripe code, such as ORA_SVC_CRM or ORA_SVC_HCM. -
SubmitDateTrunc: string
(date)
Title:
Submit Time Truncated
The date the underlying work object was submitted truncated to the day. -
SubmitTime: string
(date-time)
Title:
Submit Time
The time that the underlying work object was submitted. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the omnichannel event can be updated. -
Value: string
Title:
Value
Maximum Length:128
A value associated with the omnichannel event. The meaning of the value is event specific. -
WorkObjectId: integer
(int64)
Title:
Work Object ID
The unique identifier of the work object associated to the omnichannel event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.