Get a conversation
get
/crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}
Request
Path Parameters
-
ConversationNumber(required): string
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 : conversations-item-response
Type:
Show Source
object
-
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit organization associated with the conversation. -
ConversationAlternateId: string
Title:
Conversation Alternate ID
Maximum Length:255
The alternate unique identifier of the conversation. -
ConversationId: integer
(int64)
Title:
Conversation ID
Read Only:true
The unique identifier of the conversation. -
ConversationNumber: string
Title:
Conversation Number
Maximum Length:30
The alternate key identifier of the conversation. -
conversationReferences: array
Conversation References
Title:
Conversation References
Conversation references. -
ConversationSortDate: string
(date-time)
Title:
Conversation Sort Date
Read Only:true
The date field using which the conversation can be sorted. Currently it's the latest date when a message in the conversation was updated. -
ConversationStatusCd: string
Title:
Conversation Status Code
Maximum Length:30
The code indicating the status of the conversation, such as OPEN or CLOSED. -
ConversationStatusCdMeaning: string
Title:
Conversation Status
Read Only:true
Maximum Length:255
The status of the conversation, such as Open or Closed. -
ConversationTypeCd: string
Title:
Conversation Type Code
Maximum Length:30
The code indicating the type of the conversation, such as Customer or Collaboration. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the conversation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the conversation was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the conversation was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the conversation. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the conversation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalSystemReference: string
Title:
Original Application Reference
Maximum Length:1000
A unique reference key of the conversation message from the original application. -
OriginatedConversationId: integer
(int64)
Title:
Originated Conversation ID
The unique identifier of the original conversation from which the current conversation was created. -
OriginatedConversationNumber: string
Title:
Originating Conversation Number
Maximum Length:30
The alternate key identifier of the original conversation from which the current conversation was created. -
PrimaryMessageId: integer
(int64)
Title:
Primary Message ID
The unique identifier of the primary message in the conversation. -
PrimaryMessageNumber: string
Title:
Primary Message Number
Maximum Length:30
The alternate key identifier of the primary message in the conversation. -
PrimaryMessageTitle: string
Title:
Subject
Read Only:true
Maximum Length:1000
The title of the primary message associated with the conversation. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.
Nested Schema : Conversation References
Type:
array
Title:
Conversation References
Conversation references.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : conversations-conversationReferences-item-response
Type:
Show Source
object
-
ConversationId: integer
(int64)
Title:
Conversation ID
The unique identifier of the conversation with which the business object is associated. -
ConversationNumber: string
Title:
Conversation Number
Maximum Length:30
The alternate key identifier of the conversation with which the business object is associated. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the conversation reference. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the conversation reference was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the conversation reference was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the conversation reference. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the conversation reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the business object associated with the conversation. -
ObjectNumber: string
Title:
Object Number
Maximum Length:255
The alternate key identifier of the business object associated with the conversation. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS. -
ObjectTypeCdMeaning: string
Title:
Object Type
Read Only:true
Maximum Length:255
The object type, such as Opportunity, Service Request, Activity, Sales Lead or Account. -
ReferenceId: integer
(int64)
Title:
Reference ID
Read Only:true
The unique identifier of the conversation reference. -
ReferenceNumber: string
Title:
Reference Number
Maximum Length:30
The public unique identifier of the conversation reference.
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
- ConversationStatusCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_CONV_STATUS_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: ConversationStatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ConversationTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_CONV_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: ConversationTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StripeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: StripeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- conversationReferences
-
Operation: /crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferencesParameters:
- ConversationNumber:
$request.path.ConversationNumber
Conversation references. - ConversationNumber: