コレクション オブジェクト
コレクション オブジェクトは、アイテムのリストを格納する汎用オブジェクトです。 格納されるアイテムの型は、使用される具体的なコレクション オブジェクトによって異なります。 次のプロパティが存在します。
| 名前 | 型 | 説明 |
|---|---|---|
| items | Array | このオブジェクトに格納されているアイテムの配列。 |
| total_items | 数値 | (任意) この情報が利用可能な場合は、コレクションに存在するアイテムの総数。 |
| returns_items | 数値 | このページに存在するアイテムの数。 |
| offset | 数値 | (任意) このページがコレクションの最初のページでない場合は、その前のアイテムの数。 |
| self | リンク | このコレクションを表すリソースを参照するリンク。 |
| next | リンク | (任意) 取得するアイテムがさらにある場合は、コレクション内の次のチャンクへのリンク。 |
| previous | リンク | (任意) コレクションの最初のチャンクでない場合は、コレクション内の前のチャンクへのリンク。 |
例
RequestResponse
{
"items":[
...The array of Entity Definition Objects...
],
"total_items":38,
"returned_items":25,
"self":{"href":"http://hostname/api/entitydefinitions"},
"next":{"href":"http://hostname/api/entitydefinitions?skip=25"}
}