1. 部分エンティティ

部分エンティティ

応答のサイズを削減するために、エンティティの要求されたメンバー グループとメンバー グループのプロパティを制限します。

そのためには、次のパラメーターのいずれかまたは両方を使用します。

名前型説明
groupsString要求された member_groups オブジェクトの name 値。
membersStringmember_groups オブジェクトに存在する、要求された members の name 値。

複数の値は , で区切って記述する必要があります。

これらのパラメーターを指定しない場合は、既定で "すべてを選択" したことになります。 この機能は、/entities リソースに使用が限定され、GET、HEAD、PUT の各要求のみをサポートしています。

メンバーに対する部分的な要求の例

GET /entities/1?members=Title,FileSize

応答:

{
    "id": 6077,
    "identifier": "655J0JFYmEC6AE8uYVL9kA",
    "properties": {
        "Title": "Pork Belly Ssäm with Mustard Seed Sauce",
        "FileSize": 0.1
    }

    ...
}

メンバー グループに対する部分的な要求の例

GET /entities/1?groups=Content

応答:

{
    "id": 6077,
    "identifier": "655J0JFYmEC6AE8uYVL9kA",
    "properties": {
        "Title": "Pork Belly Ssäm with Mustard Seed Sauce",
    }

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