Collection Data Type

Generic Collection of objects. Used by endpoints that return more than one entity.

Properties
name data type constraints description
self string   URI referencing this collection.
totalItems number required long The total number of items in the collection.

This number may be larger than the number of items in the items list. If the total count cannot be determined totalItems will be -1.

items array of object   The items in the collection.

This method may only return a subset of the items in the collection.

Example

{
  "self" : "http://example.org/collection",
  "totalItems" : 42,
  "items" : [ { }, { } ]
}