機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

リード営業コンテンツの更新

patch

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents/{SalesContentId}

リクエスト

パス・パラメータ

• SalesContentId(required): integer(int64)
  販売コンテンツの一意の識別子。
• leadsUniqID(required): string
  これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ContentItemId: string
  タイトル: Content ID

  最大長: 64

  ソース・システムからの内部コンテンツ・アイテム識別子。
• ContentItemName: string
  タイトル: Content Name

  最大長: 4000

  販売コンテンツ・アイテムの名前。
• ContentSourceSystem: string
  最大長: 50

  デフォルト値: OCE

  コンテンツ・アイテムのソース元を示します。
• DeletedInSourceFlag: boolean
  タイトル: Content Deleted in Source

  最大長: 1

  デフォルト値: false

  参照販売コンテンツ・アイテムがソース・システムで削除されるかどうかを示します。
• DisplaySequence: 整数(int32)
  タイトル: Display Sequence

  販売コンテンツがページに表示される順序を示します。
• ParentObjectType: string
  最大長: 128

  販売コンテンツ行に関連付けられた親オブジェクト・タイプ。たとえば、アカウント、担当者、リードなどです。
• PublicContentItemId: string
  タイトル: Public Content ID

  最大長: 64

  ソース・システムからの公開コンテンツ・アイテム識別子。
• PublicContentItemName: string
  タイトル: Public Content Name

  最大長: 4000

  公開販売コンテンツ・アイテムの名前。
• PublicCustomerName: string
  タイトル: Customer Name

  最大長: 4000

  公開コンテンツが公開された顧客の名前。
• PublicPublishedDate: string (date-time)
  タイトル: Publish Date

  公開コンテンツ・アイテムが公開された日付。
• PublicStoryLink: string
  タイトル: Public URL

  最大長: 4000

  公開コンテンツ・アイテムのリンク。

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE"
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : leads-SalesContents-item-response

タイプ: object

ソースを表示

• CanDelete: string
  読取り専用: true

  デフォルト値: Y

  ユーザーがコンテンツ・アイテムを削除できるかどうかを示します。
• CanUpdate: string
  読取り専用: true

  デフォルト値: Y

  ユーザーがコンテンツ・アイテムを更新できるかどうかを示します。
• ContentItemId: string
  タイトル: Content ID

  最大長: 64

  ソース・システムからの内部コンテンツ・アイテム識別子。
• ContentItemName: string
  タイトル: Content Name

  最大長: 4000

  販売コンテンツ・アイテムの名前。
• ContentItemType: string
  読取り専用: true

  コンテンツのタイプを示します。たとえば、pdf、pngなどです。
• ContentSourceSystem: string
  最大長: 50

  デフォルト値: OCE

  コンテンツ・アイテムのソース元を示します。
• DeletedInSourceFlag: boolean
  タイトル: Content Deleted in Source

  最大長: 1

  デフォルト値: false

  参照販売コンテンツ・アイテムがソース・システムで削除されるかどうかを示します。
• DisplaySequence: 整数(int32)
  タイトル: Display Sequence

  販売コンテンツがページに表示される順序を示します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ParentObjectId: integer (int64)
  タイトル: Parent Object ID

  販売コンテンツ行に関連付けられたオブジェクトの一意の識別子。
• ParentObjectType: string
  最大長: 128

  販売コンテンツ行に関連付けられた親オブジェクト・タイプ。たとえば、アカウント、担当者、リードなどです。
• PublicContentItemId: string
  タイトル: Public Content ID

  最大長: 64

  ソース・システムからの公開コンテンツ・アイテム識別子。
• PublicContentItemName: string
  タイトル: Public Content Name

  最大長: 4000

  公開販売コンテンツ・アイテムの名前。
• PublicCustomerName: string
  タイトル: Customer Name

  最大長: 4000

  公開コンテンツが公開された顧客の名前。
• PublicPublishedDate: string (date-time)
  タイトル: Publish Date

  公開コンテンツ・アイテムが公開された日付。
• PublicStoryLink: string
  タイトル: Public URL

  最大長: 4000

  公開コンテンツ・アイテムのリンク。
• SalesContentId: integer (int64)
  タイトル: Sales Content ID

  読取り専用: true

  販売コンテンツの一意の識別子。

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CanDelete":{
            "type":"string",
            "description":"Indicates whether user can delete the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "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
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "CanUpdate":{
            "type":"string",
            "description":"Indicates whether user can update the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"Indicates the type of content, for example pdf, png, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated to the sales content row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

「トップに戻る」