You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

The configuration and control API provides functionality that allows a administrator to perform actions such as adding a seed to crawl, or beginning or stopping a crawl. This API will provide the functionality required by the Aspire User interface and will be extensively used by it. The API will also be used by any external process (or script) that needs to control Aspire

Policy

Workflow

Schedule

Services

Common parameters large lists

To allow paging of responses that might return large amounts of data (typically "list" requests), requests will accept paging parameters as shown below

NameTypeDefaultDescription
offsetlong0

The offset in to the results list from which results should be returned

sizelong25/unlimited

The (maximum) number of items to be returned in the results list

Note: The results list is only limited if the offset parameter is set (even to 0). If offset is not set, Aspire will assume you are trying to retrieve all items


Where paging parameters are applied, Aspire will add a "count" to the returned object to inform the total number of objects that exists 




  • No labels