Collection object
Version: 3.3
The Collection Object is a generic object that contains a list of items. The type of item contained depends on the concrete Collection Object used. The following properties exist:
Name | Type | Description |
---|---|---|
items | Array | The array of items contained in this object. |
total_items | Number | Optionally, the total number of items present in the collection if this information is available. |
returned_items | Number | The number of items present in this page. |
offset | Number | Optionally, if this is not the first page in the collection, the number of items before it. |
self | Link | A link referring to the resource that represents this collection. |
next | Link | Optionally, a link to the next chunk in the collection, if there are more items to be retrieved. |
previous | Link | Optionally, a link to the previous chunk in the collection, if this is not the first chunk in the collection. |
Example
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"}
}