Modify a sales content
patch
/crmRestApi/resources/11.13.18.05/salesContents/{SalesContentId}
Request
Path Parameters
-
SalesContentId(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
-
ContentItemId: string
Title:
Content ID
Maximum Length:64
The unique identifier of the content. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the content. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
The source system where the content resides. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether the content is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The number indicating order of display of the content. -
ParentObjectType: string
Maximum Length:
128
The parent object type, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public identifier for the content. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The content name used for public profiles. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The customer name used for public profiles. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The publish date for public content. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The public link to the content for public profiles.
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 : salesContents-item-response
Type:
Show Source
object
-
CanDelete: string
Read Only:
true
Default Value:Y
Indicates whether the content association can be deleted. -
CanUpdate: string
Read Only:
true
Default Value:Y
Indicates whether the content association can be updated. -
ContentItemId: string
Title:
Content ID
Maximum Length:64
The unique identifier of the content. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the content. -
ContentItemType: string
Read Only:
true
The content item type. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
The source system where the content resides. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether the content is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The number indicating order of display of the content. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentObjectId: integer
(int64)
Title:
Parent Object ID
The unique identifier of the parent object. -
ParentObjectType: string
Maximum Length:
128
The parent object type, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public identifier for the content. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The content name used for public profiles. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The customer name used for public profiles. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The publish date for public content. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The public link to the content for public profiles. -
SalesContentId: integer
(int64)
Title:
Sales Content ID
Read Only:true
The unique identifier of the sales content.
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.