REST API

実体

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

エンティティオブジェクトには、エンティティの状態が含まれます。次のプロパティが存在します。

名前	種類	形容
id	数	エンティティのID。
identifier	糸	エンティティの一意の識別子。
self	リンク	このエンティティのリソースへのリンク。
entitydefinition	リンク	このエンティティを定義するエンティティ定義リソースへのリンク。
properties	オブジェクト	プロパティと値を含むディクショナリオブジェクト。内容は、このエンティティに関連付けられたエンティティ定義に大きく依存します。
relations	オブジェクト	各リレーションについて、リレーションにちなんで名付けられたプロパティを含み、特定のリレーションが「ネスト」として設定されているかどうかに応じて、Entity RelationオブジェクトまたはLinkオブジェクトのいずれかを値として含むディクショナリオブジェクト。
DiscussionOptions	オブジェクト	コメントが作成されたページの詳細 (URL、ページID、ページ名) を含むオブジェクト。これは、コメントを製品にリンクする場合はオプションですが、メール通知やコメントのページへのリダイレクトには必須です。

プロパティディクショナリのプロパティの値は、このエンティティに関連付けられているエンティティ定義で定義されているプロパティの種類に従って書式設定されます。次の表では、さまざまなプロパティの種類とサポートされている値の形式について説明します。

種類	サポートされている値の形式
整数	有効な32ビット整数を含む数値、有効な32ビット整数を含む文字列、ブール値 (trueとfalseをそれぞれ1と0に変換)
小数	数値、有効な小数を含む文字列、ブール値 (trueとfalseをそれぞれ1と0に変換)
糸	数値(文字列に変換)、文字列、ブール値(文字列に変換)
日時	ISO 8601形式の日付と時刻を含む文字列
ブーリアン	1または0を含む数値、"true" または "false" を含む文字列、ブール値

多言語プロパティ (エンティティ定義でis_multilanguageでマーク) は、値をオブジェクトとして格納します。各カルチャは、Labelsオブジェクトと同様に、RFC 4647言語コードにちなんで名付けられたプロパティで表されます。

さらに、複数の値を持つことができるプロパティ (エンティティ定義のプロパティ定義では、is_multivalue propertyで示されます) には、それぞれのタイプの値の配列が含まれます。

多言語、複数値のプロパティには、前述のカルチャオブジェクト内の配列に値が含まれます。

エンティティ定義の例

{
  "id":1,
  "identifier": "00amyWGct0y_ze4lIsj2Mw",
  "properties":{
    "Property1":"Hello, World!",
    "Property2":[41, 42, 43],
    "Property3":{
      "en-US":true,
      "nl-BE":false
    },
    "Property4":"2013-04-30T14:22:42+02:00",
    "Property5":3.1415
  },
  "relations":{
    "R1":{
      "href":"http://<hostname>/api/entities/1/relations/R1"
    },
    "R2": {
      "children":[
        {
          "href":"http://<hostname>/entities/2"
        },
        {
          "href":"http://<hostname>/entities/3"
        }
      ],
      "self":{
        "href":"http://<hostname>/entities/1/relations/R2"
      }
    }
  },
  "entitydefinition":{
    "href":"http://<hostname>/api/entitydefinitions/EntityDefinition1"
  }
}

新しいM.Discussionエンティティを作成する要求の例

{
    "properties":{
        "DiscussionMessage": "<p>test</p>",
        "DiscussionOptions": {
            "absolute_url": "https://<hostname>/en-us/ch-products/ch-productssearch/ch-productdetails/34182?tab28432=Comments",
            "page_id": 28422,
            "page_name": "CH-ProductDetails",
            "entity_id": 34182
    },
    "Discussion.IsDeleted": null
  },
    "relations": {
        "PCMProductToDiscussion": {
            "parent": {
                "href": "https://<hostname>/api/entities/34182"
            }
        }
    },
    "entitydefinition":{
        "href":"https://<hostname>/api/entitydefinitions/M.Discussion"
    }
}

この記事を改善するための提案がある場合は、お知らせください!