logo
logo

Collection Object

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:

NameTypeDescription
itemsArrayThe array of items contained in this object.
total_itemsNumberOptionally, the total number of items present in the collection if this information is available.
returned_itemsNumberThe number of items present in this page.
offsetNumberOptionally, if this is not the first page in the collection, the number of items before it.
selfLinkA link referring to the resource that represents this collection.
nextLinkOptionally, a link to the next chunk in the collection, if there are more items to be retrieved.
previousLinkOptionally, a link to the previous chunk in the collection, if this is not the first chunk in the collection.

Example

{
    "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"}
}

See also

Can we improve this article ? Provide feedback