The configuration and control API provides functionality that allows a an administrator to perform actions such as adding a seed to 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
Those parts are described here once for all endpoints. They are referenced referenced from the specific chapters when needed.
The offset in to into the results list from which results should be returned
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 the size is not set, Aspire will assume you are trying to retrieve all items. TODO: the defaults not implemented
Some update endpoint queries support an update update object which together with the filtering above allows for "update by query" functionality. The update is basically a JSON object with the following format
Aspire's API will return both an HTTP response code and a JSON body indicating the success or failure of all calls. The following status codes are used
Success with errors (batch mode)*
|201 TODO: not implemented||Created|
* batch requests requests (those calls capable of creating, updating, deleting, or controlling more than a single item/object at a time - update multiple connectors for example) will return a status of 200 for the call itself and other status inside the Json body.
Should multiple items/objects to be affected and some (or all) result in errors, information about any unsuccessful call will be included in an error section for the response. The The response shown below is an example of the body returned if four connectors were submitted for create creation and two encountered and an error (response status 200)