Update a conversation reference
patch
/crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences/{ReferenceId}
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=
-
ReferenceId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ConversationId: integer
(int64)
Title:
Conversation ID
The unique identifier of the conversation with which the business object is associated. -
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.
Response
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-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
- ObjectTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MC_OBJECT_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: