Using a collection resource
A collection resource is a resource that contains other resources. It is known as a collection resource because it is itself a first class resource. It has its own attributes similar to any other resource in addition to the instances it contains. If you want to interact with multiple resources, you must use a collection resource.
Using collection resources, you can search, sort, and paginate responses.
To use a collection resource, make a GET request to the collection resource Uniform Resource Identifier (URI).
The following table describes collection resource attributes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
string |
The fully qualified location URI of the collection resource. |
|
|
integer |
The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100. The default value is 10. This is a pagination-specific attribute. |
|
|
array |
An array containing the current page of resources. The size of this array can be less than the requested limit, for example, if the limit in the request is greater than the maximum allowed. This also applies if the response represents the final page in the total collection and the item count of the final page is less than the limit. This is a pagination-specific attribute. |