Get a service request interaction
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srInteractionReferences/{ReferenceId}
Request
Path Parameters
-
ReferenceId(required): integer(int64)
The unique identifier of the service request interaction reference.
-
SrNumber(required): string
The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
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 : serviceRequests-srInteractionReferences-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
Read Only:true
The unique identifier of the interaction account. -
AccountPartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The name of the interaction account. -
ChannelDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:400
The name of the display channel. -
ChannelId: integer
(int64)
Title:
Channel ID
Read Only:true
The unique identifier of the interaction channel. -
ChannelTypeCd: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
ContactPartyId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the interaction contact. -
ContactPartyUniqueName: string
Title:
Contact
Read Only:true
Maximum Length:900
The name of the interaction contact. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the interaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the interaction was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the interaction reference has been deleted. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
A brief description of the interaction. -
DirectionCd: string
Title:
Direction
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_INBOUND
The code indicating whether the interaction is inbound or outbound. -
EndTime: string
(date-time)
Title:
End Time
Read Only:true
The date and time when the interaction ends. -
InteractionId: integer
(int64)
Title:
Interaction ID
Read Only:true
The unique identifier of the interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the interaction was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the interaction. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the interaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalSystemReference: string
Title:
Original System
Read Only:true
Maximum Length:255
The original system of reference for an interaction that was imported. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
Read Only:true
The unique identifier of the agent who owns the interaction. -
OwnerResourcePartyUniqueName: string
Title:
Resource Name
Read Only:true
Maximum Length:900
The name of the resource who is an internal interaction owner associated with the interaction, such as a service agent. -
ParentInteractionId: integer
(int64)
Title:
Parent Interaction ID
Read Only:true
The unique identifier of the parent interaction. -
Payload: string
(byte)
Title:
Payload
Read Only:true
The payload associated with the interaction. -
QueueId: integer
(int64)
Title:
Queue ID
Read Only:true
The unique identifier of the interaction queue. -
QueueName: string
Title:
Name
Read Only:true
Maximum Length:400
The name of the interaction queue. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the service request interaction reference. -
StartTime: string
(date-time)
Title:
Start Time
Read Only:true
The date and time when the interaction starts. -
StatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_SVC_OPEN
The code indicating the status of the interaction. A list of accepted values is defined in the lookup ORA_SVC_IM_STATUS_CD. -
StripeCd: string
Title:
Stripe Code
Read Only:true
Maximum Length:30
The application stripe of the interaction. -
TopLevelFlag: boolean
Title:
Top Level
Read Only:true
Indicates if the interaction is the top level interaction in the hierarchy. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the interaction reference has been updated.
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.
Links
- ChannelTypeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD
The list of values for channel types such as email, phone, social, and so on. - finder:
- DirectionCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_IM_DIRECTION_CD
The list of values for the direction of the interaction, either inbound or outbound. - finder:
Examples
The following example shows how to get a service request interaction by submitting a GET request on the REST resource.
Example of Request Header
The following shows an example of the request header.
GET crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following example shows the contents of the response body.
{ "ReferenceId": 300100103890826, "InteractionId": 300100103890825, "ParentInteractionId": 300100103890825, "TopLevelFlag": "true", "Description": "Sent SrMessage 300100097060036", "ChannelId": 2, "ChannelDisplayName": "E-Mail (Seeded)", "ChannelTypeCd": "ORA_SVC_EMAIL", "AccountPartyId": null, "AccountPartyUniqueName": null, "ContactPartyId": 5266, "ContactPartyUniqueName": "Brian Adams ", "QueueId": null, "QueueName": null, "OwnerResourceId": 100010025532672, "OwnerResourcePartyUniqueName": "Gabrielle Lee", "StartTime": "2017-04-10T18:01:25+00:00", "EndTime": "2017-04-10T17:59:40.701+00:00", "StatusCd": "ORA_SVC_CLOSED", "OriginalSystemReference": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-04-10T18:01:25+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2017-04-10T18:01:26.022+00:00", "LastUpdateLogin": "4CD4AA2920F63908E05356C0F20AD4D2", "DirectionCd": "ORA_SVC_OUTBOUND", "StripeCd": "ORA_SVC_CRM", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826", "name": "srInteractionReferences", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826", "name": "srInteractionReferences", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951", "name": "serviceRequests", "kind": "item" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000004951/child/srInteractionReferences/300100103890826/enclosure/Payload", "name": "Payload", "kind": "other" } ] }