機械翻訳について

ジャンプ先

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

営業コンテンツの作成

post

/crmRestApi/resources/11.13.18.05/salesContents

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• 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

  コンテンツの表示順序を示す番号。
• 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

  公開プロファイルのコンテンツへのパブリック・リンク。

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"The source system where the content resides.",
            "nullable":true,
            "default":"OCE"
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the content.",
            "nullable":false
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The customer name used for public profiles.",
            "nullable":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
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public identifier for the content.",
            "nullable":true
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type, for example Account, Contact, Lead, and so on.",
            "nullable":false
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the content.",
            "nullable":false
        },
        "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
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The content name used for public profiles.",
            "nullable":true
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the parent object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the content 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : 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

  コンテンツ・アイテム・タイプ。
• 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":"The source system where the content resides.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the content.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The customer name used for public profiles.",
            "nullable":true,
            "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
        },
        "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
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public identifier for the content.",
            "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, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the content.",
            "nullable":false,
            "x-queryable":true
        },
        "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
            }
        },
        "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
        },
        "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 content name used for public profiles.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"The content item type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
        },
        "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
        }
    }
}

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

タイプ: 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."
        }
    }
}

「トップに戻る」