Get all messages
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages
Request
Path Parameters
-
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 -
finder: string
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: Finds the service request message using the message ID.
Finder Variables:- MessageId; integer; The service request message ID passed as parameter to the finder service.
- PrimaryKey: Finds the service request message using the message ID.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- ChannelTypeCd; string; 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.
- CreatedBy; string; The user who created the message.
- CreatedByEmailAddress; string; The e-mail address of the person who created the service request message.
- CreatedByPartyId; string; The unique identifier of the party of the user who created the service request message.
- CreationDate; string; The date and time when the message was created.
- LastUpdateDate; string; The date and time when the message was last updated.
- LastUpdateLogin; string; The session login associated with the user who last updated the message.
- LastUpdatedBy; string; The user who last updated the message.
- MessageCreatedBy; string; The user who created the message in the original source system. This is applicable if the service request message was imported from another system.
- MessageExpandingState; integer; Indicates the message expanding state.
- MessageId; integer; The unique identifier of the service request message.
- MessageLastUpdateDate; string; The last updated date of the message in the original source system. This is applicable if the service request message was imported from another system.
- MessageLastUpdateLogin; string; The login of the user who last update the message in the original source system. This is applicable if the service request message was imported from another system.
- MessageLastUpdatedBy; string; The user who last update the message in the original source system. This is applicable if the service request message was imported from another system.
- MessageNumber; string; The public unique identifier of the service request message.
- MessageSubTypeCd; string; The service request message subtype.
- MessageTypeCd; string; The code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_TYPE_CD.
- NotificationProcessingStatusCd; string; The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD.
- NotificationRetryCount; integer; The number of times the system tried to send the SR message notification.
- ObjectId; integer; The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication.
- ObjectTypeCd; string; This field is reserved for internal use only.
- OriginalSystemReference; string; The identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system.
- OriginationDate; string; The date the message was created in the original source system. This is applicable if the service request message was imported from another system.
- ParentMessageId; integer; The unique identifier of the parent service request message.
- PartyName; string; The Party name of the user who the posted the message. The user can be an internal resource or a customer contact.
- PostedByPartyId; integer; The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact.
- PostedByPartyNumber; string; The public unique identifier of the person posting the message on the service request.
- PrivateInformationFlag; boolean; Indicates whether the message contains personally identifiable information.
- ProcessingId; integer; The unique identifier of the processing.
- ProcessingStatusCd; string; The code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD .
- RichTextFlag; boolean; Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N.
- RootMessageId; integer; The identifier of the root message in the message hierarchy.
- SentDate; string; The date and time when the message was sent.
- SocialPrivateFlag; boolean; Indicates whether the message was created from a private social post.
- SourceCd; string; The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD.
- SrBUOrgId; integer; The identifier of the business unit associated with the service request.
- SrId; integer; The unique identifier of the service request to which the message is associated.
- SrInlineAttachmentIds; string; The list of inline attachment identifiers associated with the service request
- SrNumber; string; The public unique number of the a service request.
- SrStripeCd; string; The application stripe of the service request.
- StatusCd; string; The code indicating the status of the message. The accepted values are Draft, Committed, and Corrected.
- Subject; string; The subject of the service request message.
- TemplateName; string; The name of the template used to send an email response to a customer.
- ThreadHierarchyLevel; integer; The level of the thread in the message hierarchy.
- ThreadId; integer; The unique ID of the service request message thread.
- VisibilityCd; string; The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.
-
totalResults: boolean
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
-
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-messages
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-item-response
Type:
Show Source
object
-
Attachment: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message. -
channelCommunication: array
Channel Communications
Title:
Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers. -
ChannelId: string
Title:
Channel
The unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel Type
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. -
CollabResource: string
Title:
Collaboration Resource
This field is reserved for internal use only. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the message. -
CreatedByEmailAddress: string
Title:
Created by Email ID
Read Only:true
Maximum Length:320
The e-mail address of the person who created the service request message. -
CreatedByPartyId: string
Title:
Created by Party ID
Read Only:true
Maximum Length:80
The unique identifier of the party of the user who created the service request message. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the message was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the message has been deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the message was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the message. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated with the user who last updated the message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageContent: string
(byte)
Title:
Message Content
The content of the message encoded in base 64 format. Any attachment associated with the message is not the content of the message. -
MessageCreatedBy: string
Title:
Created By
Maximum Length:64
The user who created the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageExpandingState: integer
Title:
Message Expand State
Indicates the message expanding state. -
MessageId: integer
(int64)
Title:
Message ID
The unique identifier of the service request message. -
MessageLastUpdateDate: string
(date-time)
Title:
Last Updated Date
The last updated date of the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdatedBy: string
Title:
Last Updated By
Maximum Length:64
The user who last update the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdateLogin: string
Title:
Last Update Login
Maximum Length:32
The login of the user who last update the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageNumber: string
Title:
Message Number
Maximum Length:30
The public unique identifier of the service request message. -
MessageSubTypeCd: string
Title:
Message Subtype
Maximum Length:30
The service request message subtype. -
MessageTypeCd: string
Title:
Message Type Code
Maximum Length:30
The code indicating the message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_TYPE_CD. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE. -
NotificationProcessingStatusCd: string
Title:
Notification Processing Status Code
Maximum Length:30
The code indicating the status of the response notification. For example, Error, Success. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD. -
NotificationRetryCount: integer
(int32)
Title:
Notification Retry Count
The number of times the system tried to send the SR message notification. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication. -
ObjectTypeCd: string
Title:
Object Type Code
Maximum Length:30
Default Value:SVC_SR_MESSAGES
This field is reserved for internal use only. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The identifier of the message record in the original source system from where the message was imported. This is applicable if the service request message was imported from another system. -
OriginationDate: string
(date-time)
Title:
Origination Date
The date the message was created in the original source system. This is applicable if the service request message was imported from another system. -
ParentMessageId: integer
(int64)
Title:
Parent Message ID
The unique identifier of the parent service request message. -
PartyName: string
Title:
Posted By
Read Only:true
Maximum Length:360
The Party name of the user who the posted the message. The user can be an internal resource or a customer contact. -
PostedByPartyId: integer
(int64)
Title:
Posted by ID
The unique identifier of the user who the posted the message. The user can be an internal resource or a customer contact. -
PostedByPartyNumber: string
Title:
Posted by Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the person posting the message on the service request. -
PrivateInformationFlag: boolean
Title:
Contains PII Data
Maximum Length:1
Indicates whether the message contains personally identifiable information. -
ProcessingId: integer
(int64)
Title:
Processing ID
Read Only:true
The unique identifier of the processing. -
ProcessingStatusCd: string
Title:
Processing Status
Maximum Length:30
Default Value:ORA_SVC_READY
The code indicating the processing status of the message. The accepted values are Ready, Processing, Error, and Success.A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_PROCESS_CD . -
ReplyToMessageId: integer
(int64)
Title:
Reply to Message ID
Read Only:true
The unique identifier of the message that is being replied to by the agent. -
RichTextFlag: boolean
Title:
Rich Text
Maximum Length:1
Default Value:true
Indicates whether the message content is in rich text format. If the format is rich text, then the value is Y, else the value is N. -
RootMessageId: integer
(int64)
Title:
Root Message Identifier
Read Only:true
The identifier of the root message in the message hierarchy. -
RootThreadCount: integer
Title:
Root Message Thread Count
Read Only:true
The number of messages under a root message in a service request. -
RootThreadLastUpdateDate: string
(date-time)
Title:
Root Message Thread Last Updated Date
Read Only:true
The latest updated date for all messages under the root message in a service request. -
RootThreadMessageLastUpdateDate: string
(date-time)
Title:
Root Thread Message Last Updated Date
Read Only:true
The date when all messages under the root message in a service request were last updated. -
SentDate: string
(date-time)
Title:
Sent Date
The date and time when the message was sent. -
SocialPrivateFlag: boolean
Title:
Private Message
Maximum Length:1
Indicates whether the message was created from a private social post. -
SourceCd: string
Title:
Source Code
Maximum Length:30
The code indicating the source of the message. For example, Agent UI, Customer UI, and API. A list of accepted values is defined in the lookup ORA_SVC_SOURCE_CD. -
SrBUOrgId: integer
(int64)
Title:
Service Request Business Unit
Read Only:true
The identifier of the business unit associated with the service request. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request to which the message is associated. -
SrInlineAttachmentIds: string
Title:
Inline Attachment Identifiers
Maximum Length:1000
The list of inline attachment identifiers associated with the service request -
SrNumber: string
Title:
Service Request Number
Maximum Length:30
The public unique number of the a service request. -
SrStripeCd: string
Title:
Service Request Application Stripe
Read Only:true
Maximum Length:30
The application stripe of the service request. -
StatusCd: string
Title:
Status Code
Maximum Length:30
The code indicating the status of the message. The accepted values are Draft, Committed, and Corrected. -
Subject: string
Title:
Subject
Maximum Length:1000
The subject of the service request message. -
TemplateName: string
Title:
Template Name
Maximum Length:240
The name of the template used to send an email response to a customer. -
ThreadCount: integer
Title:
Thread Count
Read Only:true
The number of threads in a service request message. -
ThreadHierarchyLevel: integer
Title:
Thread Hierarchy Level
Read Only:true
The level of the thread in the message hierarchy. -
ThreadId: integer
Title:
Thread Identifier
Read Only:true
The unique ID of the service request message thread. -
ThreadLastUpdateDate: string
(date-time)
Title:
Thread Last Updated Date
Read Only:true
The date when the message was last updated. -
ThreadMessageLastUpdateDate: string
(date-time)
Title:
Thread Message Last Updated Date
Read Only:true
The date when the thread message was last updated. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the message has been updated. -
VisibilityCd: string
Title:
Visibility Code
Maximum Length:30
The code indicating the privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External. A list of accepted values is defined in the lookup ORA_SVC_MESSAGE_VISIBILITY_CD.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete attachments associated with a message. An attachment includes additional information about a message.
Show Source
Nested Schema : Channel Communications
Type:
array
Title:
Channel Communications
The channel communications resource is used to view, create, update, and delete channel communications. Channel communication is information about the communication between support agents and their customers. For example, the type of communication information that is recorded includes message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsDFFVL: array
AttachmentsDFFVL
-
AttachmentsPreview: array
Attachments Preview
Title:
Attachments Preview
The attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the attachment category. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of the data. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Attachments Preview
Type:
array
Title:
Attachments Preview
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-Attachment-AttachmentsDFFVL-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : serviceRequests-messages-Attachment-AttachmentsPreview-item-response
Type:
Show Source
object
-
ImageHeight: integer
Title:
Image Height
Read Only:true
The height of the previewed image. -
ImageSource: string
Title:
Image Source
Read Only:true
The preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image Width
Read Only:true
The width of the previewed image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PageNum: integer
Title:
Page Number
Read Only:true
The number of the page in the preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : serviceRequests-messages-channelCommunication-item-response
Type:
Show Source
object
-
ChannelAccountName: string
Title:
Account Name
Read Only:true
Maximum Length:400
The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like support@abc.com. -
ChannelDisplayName: string
Title:
Display Name
Maximum Length:400
The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short Name
Maximum Length:450
The public unique identifier of the 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. -
CollabId: string
Title:
Collaboration ID
Read Only:true
Maximum Length:255
The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id. of a user. -
CollabName: string
Title:
Resource Name
Read Only:true
Maximum Length:400
The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource Identifier
The unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point ID
The unique identifier of the contact point record of the contact who is being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address and the contact point of a person for twitter would be the twitter handle. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the communication channel was created. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageNumber: string
Title:
Message Number
Read Only:true
Maximum Length:30
The public unique identifier of the service request message. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Maximum Length:30
Default Value:SVC_SR_MESSAGES
The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the person who is being communicated with. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the person who is being communicated with. The user can be an internal resource or a customer contact. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the contact associated with the service request message. -
PartyViaEndPoint: string
Title:
Party Endpoint
Maximum Length:1000
The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of the person who is a contact on the service request. -
PostIdentifier: string
Title:
Post Identifier
Maximum Length:1000
The unique identifier of the social media post record that was used to create the service request or the service request message. -
ResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with. -
ResourceTypeCd: string
Title:
Resource Type
Read Only:true
Maximum Length:30
The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD. -
RoutingCd: string
Title:
Routing Code
Maximum Length:30
The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD. -
ViaId: integer
(int64)
Title:
ID
Read Only:true
The unique identifier of the channel communication.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all messages 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/SR0000066002/child/messages
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Wed, 20 Sep 2016 11:07:50 GMT 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 in JSON format.
{ "items": [ { "MessageId": 300100092156944, "CreationDate": "2016-09-08T03:54:03-07:00", "CreatedBy": "SALES_REPRESENTATIVE", "LastUpdateDate": "2016-09-08T03:54:58-07:00", "LastUpdatedBy": "SALES_REPRESENTATIVE", "LastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "SrId": 300100092156941, "MessageTypeCd": "ORA_SVC_FORWARD", "ChannelTypeCd": "ORA_SVC_EMAIL", "ChannelId": "2", "PostedByPartyId": 100010032635399, "RichTextFlag": true, "SourceCd": null, "StatusCd": "ORA_SVC_COMMITTED", "ProcessingStatusCd": "ORA_SVC_READY", "VisibilityCd": null, "SentDate": null, "OriginationDate": "2016-09-08T03:54:03-07:00", "MessageCreatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateDate": "2016-09-08T03:54:03-07:00", "MessageLastUpdatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "OriginalSystemReference": null, "PartyName": "Dan Foreman", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156944", "name": "messages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156944", "name": "messages", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156944/lov/SourceCdLookup", "name": "SourceCdLookup", "kind": "collection" }, . . . ] }, { "MessageId": 300100092156943, "CreationDate": "2016-09-08T03:53:36-07:00", "CreatedBy": "SALES_REPRESENTATIVE", "LastUpdateDate": "2016-09-08T03:53:54-07:00", "LastUpdatedBy": "SALES_REPRESENTATIVE", "LastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "SrId": 300100092156941, "MessageTypeCd": "ORA_SVC_CUSTOMER_ENTRY", "ChannelTypeCd": null, "ChannelId": null, "PostedByPartyId": 100010032635399, "RichTextFlag": true, "SourceCd": null, "StatusCd": "ORA_SVC_COMMITTED", "ProcessingStatusCd": "ORA_SVC_READY", "VisibilityCd": null, "SentDate": null, "OriginationDate": "2016-09-08T03:53:36-07:00", "MessageCreatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateDate": "2016-09-08T03:53:36-07:00", "MessageLastUpdatedBy": "SALES_REPRESENTATIVE", "MessageLastUpdateLogin": "3BFA3959A2B535C9E053780CF10A6512", "OriginalSystemReference": null, "PartyName": "Dan Foreman", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156943", "name": "messages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages/300100092156943", "name": "messages", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, . . . ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/messages", "name": "messages", "kind": "collection" } ] }