feed APIv1.1.0

TaskCollection

The type that defines the fields for a paginated result set of tasks. The response consists of 0 or more sequenced pages where each page has 0 or more items.

Types that use TaskCollection

Not used by any types

Call that uses TaskCollection

Fields

Field
Type
Description
href
The path to the call URI that produced the current page of results.
limit
The value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method.

Note:Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.

next
The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.
offset
This value indicates the offset used for the current page of tasks being returned. For example, if the initial request used an offset of 0 and a limit of 3. Then on the first page of results, this value would be 0, and items 1-3 are returned. For the second page, this value is 3 and so on.
prev
The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.
tasks
array of Task
An array of the tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.
total
The total number of tasks that match the input criteria.