Page History
...
| Children Display | ||
|---|---|---|
|
| Anchor |
|---|
...
|
...
To allow paging of responses that might return large amounts of data (typically "list" requests), requests will accept paging parameters as shown below
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| from | long | Optional | 0 | The offset in to the results list from which results should be returned |
| size | long | Optional | 25/unlimited | The (maximum) number of items to be returned in the results list Note: The results list is only limited if the size parameter is set (even to 0). If size is not set, Aspire will assume you are trying to retrieve all items. TODO: the defaults not implemented |
Where paging parameters are applied, Aspire will add a "count" to the returned object to inform the total number of objects that exists (the fields being from, size, totalItems) TODO: not implemented
| Anchor | ||||
|---|---|---|---|---|
|
| Name | Type | Required | Description |
|---|---|---|---|
| sortBy | string | Optional | Field by which results are sorted |
| sortMode | string | Optional | Sort mode
|
Responses
Aspire's API will return both an HTTP response code and a Json body indicating success or failure of all calls. The following status codes are used
...
Overview
Content Tools