Get a message
get
/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/messages/{MessageId}
Request
Path Parameters
-
MessageId(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=
-
SrId(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: string
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: string
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 : hrHelpDeskRequests-messages-item-response
Type:
Show Source
object-
AILogLevelCd: string
Title:
AI Log Level CodeMaximum Length:30Default Value:ORA_SVC_NONEIndicates the AI log level that the SR Message was captured at, such as NONE, INFO, and FINE. -
Attachment: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
channelCommunication: array
Service Request Message Communications
Title:
Service Request Message CommunicationsThe channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers. -
ChannelId: string
Title:
ChannelThe unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel TypeMaximum Length:30The channel type, such a email, phone, social, and so on. -
CollabResource: string
Title:
Collaboration ResourceThe unique identifier of the collaboration network user that the internal users are communicating with. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the message. -
CreatedByEmailAddress: string
Title:
Created by Email IDRead Only:trueMaximum Length:320The email Id of the person who created the service request message. -
CreatedByPartyId: string
Title:
Created by Party IDRead Only:trueMaximum Length:80The unique party identifier of the person who created the service request message. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the message was created. -
DeleteFlag: boolean
Title:
Can DeleteRead Only:trueIndicates whether the user has access to delete the record. -
FeedFlag: boolean
Title:
Feed FlagMaximum Length:1Default Value:trueIndicates whether the SR Message should be pushed to the SR Feed. Values are Y and N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the message was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the message. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the message. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageContent: string
(byte)
Title:
Message ContentThe content of the service request message. -
MessageCreatedBy: string
Title:
Created ByMaximum Length:64The 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 StateThe message expanding state. -
MessageId: integer
(int64)
Title:
Message IDThe unique identifier of the service request message. -
MessageLastUpdateDate: string
(date-time)
Title:
Last Updated DateThe date when the message was last updated in the original source system. This is applicable if the service request message was imported from another system. -
MessageLastUpdatedBy: string
Title:
Last Updated ByMaximum Length:64The user who last updated 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 LoginMaximum Length:32The login of the user who last updated the message in the original source system. This is applicable if the service request message was imported from another system. -
MessageNumber: string
Title:
Message NumberMaximum Length:30The public unique identifier of the service request message. -
MessageSubTypeCd: string
Title:
Message SubtypeMaximum Length:30The service request message subtype. -
MessageTypeCd: string
Title:
Message Type CodeMaximum Length:30The message type. The accepted values are Response, Customer Entry, System Note, System Response, and Internal Note. -
NetworkTypeCd: string
Title:
NetworkRead Only:trueMaximum Length:30The type of social network. -
NotificationProcessingStatusCd: string
Title:
Notification Processing Status CodeMaximum Length:30The notification processing status code. -
NotificationRetryCount: integer
(int32)
Title:
Notification Retry CountThe notification retry count. -
ObjectId: integer
(int64)
Title:
Object IDThe unique identifier of the object. -
ObjectTypeCd: string
Title:
Object Type CodeMaximum Length:30Default Value:SVC_SR_MESSAGESThe 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. -
OriginalSystemReference: string
Title:
Original SystemMaximum Length:255The unique 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 DateThe 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 IDThe unique identifier of the parent message. -
PartyName: string
Title:
Posted ByRead Only:trueMaximum Length:360The party name of the user who posted the message. The user can be an internal resource or a customer contact. -
PostedByPartyId: integer
(int64)
Title:
Posted by IDThe 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 NumberRead Only:trueMaximum Length:30The alternative key for the party identifier of the person posting the service request message. -
PrivateInformationFlag: boolean
Title:
Contains PII DataMaximum Length:1Indicates whether the message contains personally identifiable information. -
ProcessingId: integer
(int64)
Title:
Processing IDRead Only:trueThe unique identifier of the processing. -
ProcessingStatusCd: string
Title:
Processing StatusMaximum Length:30Default Value:ORA_SVC_READYThe processing status of the message. The accepted values are Ready, Processing, Error, and Success. -
ReplyToMessageId: integer
(int64)
Title:
Reply to Message IDRead Only:trueThe unique identifier of the customer message to which the agent is replying to. -
RichTextFlag: boolean
Title:
Rich TextMaximum Length:1Default Value:trueIndicates 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 IdentifierRead Only:trueThe identifier of the root message in the message hierarchy. -
RootThreadCount: integer
Title:
Root Message Thread CountRead Only:trueThe number of messages under a root message in a service request. -
RootThreadLastUpdateDate: string
(date-time)
Title:
Root Message Thread Last Updated DateRead Only:trueThe last updated date for all messages under the root message in a service request. -
RootThreadMessageLastUpdateDate: string
(date-time)
Title:
Root Thread Message Last Updated DateRead Only:trueThe date when all messages under the root message in a service request were last updated. -
SentDate: string
(date-time)
Title:
Sent DateThe date and time when the message was sent. -
SocialPrivateFlag: boolean
Title:
Private MessageMaximum Length:1Indicates whether the service request was created from a private social post. -
SourceCd: string
Title:
Source CodeMaximum Length:30The source of the message. -
SrBUOrgId: integer
(int64)
Title:
Service Request Business UnitRead Only:trueThe identifier of the business unit associated with the service request. -
SrId: integer
(int64)
Title:
Service Request IDThe unique identifier of the service request to which the message is associated. -
SrInlineAttachmentIds: string
Title:
Inline Attachment IdentifiersMaximum Length:1000The list of inline attachment identifiers associated with the service request -
SrNumber: string
Title:
Service Request NumberMaximum Length:30The alternative key for the service request number. -
SrStripeCd: string
Title:
Service Request Application StripeRead Only:trueMaximum Length:30The application stripe of the service request. -
StatusCd: string
Title:
Status CodeMaximum Length:30The status of the message. The accepted values are Draft, Committed, and Corrected. -
Subject: string
Title:
SubjectMaximum Length:1000The subject of the service request message. -
TemplateName: string
Title:
Template NameMaximum Length:240The name of the template that's used for outbound communication of the message. -
ThreadCount: integer
Title:
Thread CountRead Only:trueThe number of threads in a service request message. -
ThreadHierarchyLevel: integer
Title:
Thread Hierarchy LevelRead Only:trueThe thread hierarchy level. -
ThreadId: integer
Title:
Thread IdentifierRead Only:trueThe unique identifier of the service request message thread. -
ThreadLastUpdateDate: string
(date-time)
Title:
Thread Last Updated DateRead Only:trueThe date when the thread was last updated. -
ThreadMessageLastUpdateDate: string
(date-time)
Title:
Thread Message Last Updated DateRead Only:trueThe date when the thread message was last updated. -
UpdateFlag: boolean
Title:
Can UpdateRead Only:trueIndicates whether the user has access to update the record. -
VisibilityCd: string
Title:
Visibility CodeMaximum Length:30The privacy level of the message. The accepted values are Internal and External. Null value indicates that the message is External.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Service Request Message Communications
Type:
arrayTitle:
Service Request Message CommunicationsThe channel communications resource is used to view, create, update, and delete a communication. It contains information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : hrHelpDeskRequests-messages-Attachment-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
AttachmentsDFFVL: array
AttachmentsDFFVL
-
AttachmentsPreview: array
Attachments Preview
Title:
Attachments PreviewThe attachments preview resource is used to preview the attachment pages. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Attachments Preview
Type:
arrayTitle:
Attachments PreviewThe attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : hrHelpDeskRequests-messages-Attachment-AttachmentsDFFVL-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
AttachedDocumentId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : hrHelpDeskRequests-messages-Attachment-AttachmentsPreview-item-response
Type:
Show Source
object-
ImageHeight: integer
Title:
Image HeightRead Only:trueThe height of the previewed image. -
ImageSource: string
Title:
Image SourceRead Only:trueThe preview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image WidthRead Only:trueThe width of the previewed image. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PageNum: integer
Title:
Page NumberRead Only:trueThe number of the page in the preview.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : hrHelpDeskRequests-messages-channelCommunication-item-response
Type:
Show Source
object-
ChannelAccountName: string
Title:
Account NameRead Only:trueMaximum Length:400The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support. -
ChannelDisplayName: string
Title:
Display NameMaximum Length:400The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel IDThe unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short NameMaximum Length:450The public unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel TypeRead Only:trueMaximum Length:30The 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 IDRead Only:trueMaximum Length:255The 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 NameRead Only:trueMaximum Length:400The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource IdentifierThe unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point IDThe unique identifier of the contact point record of the contact who's 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 while the contact point of a person for twitter would be the twitter handle. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the communication channel was created. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object IdentifierThe unique identifier of the inbound object that resulted in the creation of the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated ByRead Only:trueMaximum Length:64The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update LoginRead Only:trueMaximum Length:32The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageNumber: string
Title:
Message NumberRead Only:trueMaximum Length:30The public unique identifier of the service request message. -
NetworkTypeCd: string
Title:
NetworkRead Only:trueMaximum Length:30The 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 IDThe 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 TypeRead Only:trueMaximum Length:30Default Value:SVC_SR_MESSAGESThe 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 IDThe unique party identifier of the person who's being communicated with. -
PartyName: string
Title:
Party NameRead Only:trueMaximum Length:360The party name of the person who's being communicated with. -
PartyNumber: string
Title:
Party NumberRead Only:trueMaximum Length:30The public unique identifier of the contact associated with the service request message. -
PartyViaEndPoint: string
Title:
Party EndpointMaximum Length:1000The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party. -
PersonId: integer
(int64)
Title:
Person IDThe unique person ID of the contact. -
PostIdentifier: string
Title:
Post IdentifierMaximum Length:1000The 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 IDRead Only:trueThe 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 TypeRead Only:trueMaximum Length:30The 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 CodeMaximum Length:30The 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. -
ViaId: integer
(int64)
Title:
IDRead Only:trueThe unique identifier of the service request channel communication record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- AILogLevelLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AI_LOG_LEVELS
The following properties are defined on the LOV link relation:- Source Attribute: AILogLevelCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Attachment
-
Parameters:
- MessageId:
$request.path.MessageId - SrId:
$request.path.SrId
The attachments resource is used to view, create, and update attachments. - MessageId:
- ChannelLOV
-
Operation: /crmRestApi/resources/11.13.18.05/channelsParameters:
- finder:
EnabledChannelByBUAndStripeAndTypeFinder%3BChannelTypeCd%3D{ChannelTypeCd}%2CStripeCd%3D{SrStripeCd}%2CBUOrgId%3D{SrBUOrgId}
The following properties are defined on the LOV link relation:- Source Attribute: ChannelId; Target Attribute: ChannelId
- Display Attribute: DisplayName
- finder:
- ChannelTypeCdLookup
-
Parameters:
- finder:
IsInteractiveFinder
The following properties are defined on the LOV link relation:- Source Attribute: ChannelTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CollabResourceLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CollabResource; Target Attribute: DisplayName
- Display Attribute: DisplayName, Name, ResourceType
- FeedFlagLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: FeedFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MessageSubTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_SUB_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: MessageSubTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MessageTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: MessageTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- NetworkTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: NetworkTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
The following properties are defined on the LOV link relation:- Source Attribute: SourceCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_STATUS_CD
The following properties are defined on the LOV link relation:- Source Attribute: StatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- VisibilityCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MESSAGE_VISIBILITY_CD
The following properties are defined on the LOV link relation:- Source Attribute: VisibilityCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- channelCommunication
-
Parameters:
- MessageId:
$request.path.MessageId - SrId:
$request.path.SrId
The channel communications resource is used to view, create, update, and delete a channel communication. It's information about the communication between support agents and workers. For example, the type of information recorded about communications include message identifiers, contact identifiers, and contact point identifiers. - MessageId:
Examples
The following example shows how to get a message of a hr helpdesk service request by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \
'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971'
-X GET
Example of Response Body
The following shows an example of the response body in JSON format.
{
"MessageId": 300100569876971,
"CreationDate": "2022-10-27T06:40:13+00:00",
"CreatedBy": "automhrhdadm1",
"CreatedByPartyId": "300100176763503",
"CreatedByEmailAddress": "sendmail-test-discard@oracle.com",
"LastUpdateDate": "2022-10-27T06:40:13.718+00:00",
"LastUpdatedBy": "automhrhdadm1",
"LastUpdateLogin": "EB4D11869E889DFDE0536F6315ACC90C",
"MessageNumber": "CDRM_0000003004",
"SrId": 300100569876128,
"SrNumber": "HRHD0000003008",
"MessageTypeCd": "ORA_SVC_RESPONSE",
"MessageSubTypeCd": null,
"ChannelTypeCd": "ORA_SVC_WEB",
"ChannelId": "300100545723088",
"PostedByPartyId": 300100176763503,
"PostedByPartyNumber": "CDRM_842694",
"RichTextFlag": true,
"SourceCd": "ORA_SVC_AGENT_UI",
"StatusCd": "ORA_SVC_COMMITTED",
"ProcessingStatusCd": "ORA_SVC_READY",
"VisibilityCd": null,
"SentDate": null,
"OriginationDate": "2022-10-27T06:40:13+00:00",
"MessageCreatedBy": "automhrhdadm1",
"MessageLastUpdateDate": "2022-10-27T06:40:13+00:00",
"MessageLastUpdatedBy": "automhrhdadm1",
"MessageLastUpdateLogin": "EB4D11869E889DFDE0536F6315ACC90C",
"OriginalSystemReference": null,
"PartyName": "automhrhdadm1 svc",
"ParentMessageId": null,
"ThreadId": 300100569876971,
"ThreadCount": 1,
"MessageExpandingState": null,
"ThreadHierarchyLevel": 1,
"ThreadLastUpdateDate": "2022-10-27T06:40:13.718+00:00",
"ThreadMessageLastUpdateDate": "2022-10-27T06:40:13+00:00",
"SocialPrivateFlag": false,
"PrivateInformationFlag": null,
"UpdateFlag": true,
"DeleteFlag": true,
"ReplyToMessageId": null,
"NetworkTypeCd": null,
"ProcessingId": null,
"NotificationProcessingStatusCd": null,
"NotificationRetryCount": null,
"ObjectTypeCd": null,
"ObjectId": null,
"TemplateName": null,
"CollabResource": null,
"RootMessageId": 300100569876971,
"RootThreadCount": 1,
"RootThreadLastUpdateDate": "2022-10-27T06:40:13.718+00:00",
"RootThreadMessageLastUpdateDate": "2022-10-27T06:40:13+00:00",
"Subject": "resolved sr",
"SrStripeCd": "ORA_SVC_HRHD",
"SrBUOrgId": 204,
"SrInlineAttachmentIds": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971",
"name": "messages",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971",
"name": "messages",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008",
"name": "hrHelpDeskRequests",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/SourceCdLookup",
"name": "SourceCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/CollabResourceLOV",
"name": "CollabResourceLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/MessageSubTypeCdLookup",
"name": "MessageSubTypeCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/StatusCdLookup",
"name": "StatusCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/VisibilityCdLookup",
"name": "VisibilityCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/MessageTypeCdLookup",
"name": "MessageTypeCdLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/NetworkTypeLOV",
"name": "NetworkTypeLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/ChannelLOV",
"name": "ChannelLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/lov/ChannelTypeCdLookup",
"name": "ChannelTypeCdLookup",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/child/Attachment",
"name": "Attachment",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/child/channelCommunication",
"name": "channelCommunication",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/HRHD0000003008/child/messages/300100569876971/enclosure/MessageContent",
"name": "MessageContent",
"kind": "other"
}
]
}