Jump to

• Request
• Response

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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the content.",
            "nullable":false
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the content.",
            "nullable":false
        },
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"The source system where the content resides.",
            "nullable":true,
            "default":"OCE"
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the content is deleted in source system.",
            "nullable":true,
            "default":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The number indicating order of display of the content.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type, for example Account, Contact, Lead, and so on.",
            "nullable":false
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public identifier for the content.",
            "nullable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The content name used for public profiles.",
            "nullable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The customer name used for public profiles.",
            "nullable":true
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The publish date for public content.",
            "format":"date-time",
            "nullable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The public link to the content for public profiles.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : salesContents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CanDelete":{
            "type":"string",
            "description":"Indicates whether the content association can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CanUpdate":{
            "type":"string",
            "description":"Indicates whether the content association can be updated.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the content.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the content.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"The content item type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"The source system where the content resides.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the content is deleted in source system.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The number indicating order of display of the content.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the parent object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public identifier for the content.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The content name used for public profiles.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The customer name used for public profiles.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The publish date for public content.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The public link to the content for public profiles.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesContentId":{
            "title":"Sales Content ID",
            "type":"integer",
            "description":"The unique identifier of the sales content.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top