コレクション

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

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

コレクションオブジェクトは、アイテムのリストを含む汎用オブジェクトです。含まれるアイテムの種類は、使用される具体的なコレクションオブジェクトによって異なります。以下のプロパティが存在します。

名称

種類

概要

items

アレイ

このオブジェクトに含まれるアイテムの配列です。

total_items

番号

オプションで、この情報が利用可能な場合はコレクション内の総数も記載可能です。

returned_items

番号

このページにあるアイテムの数。

offset

番号

オプションで、コレクションの最初のページでない場合は、その前のアイテム数を指定します。

self

このコレクションを表すリソースを参照するリンクです。

オプションとして、収集すべきアイテムが増えた場合は、コレクション内の次のチャンクへのリンクも付けることができます。

オプションとして、コレクションの最初のチャンクでない場合は、前のチャンクへのリンクも含めてください。

例

{ "items": ...The array of Entity Definition Objects... , "total_items"

, "returned_items"

, "self":{"href":"http:///api/entitydefinitions"}, "next":{"href":"http:///api/entitydefinitions?skip=25"} }