The seeds API provides functionality that allows a administrator to perform actions such as adding and configuring a seed to crawl, or beginning or stopping a crawl
Table of Contents |
---|
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all seedsLists all the seeds configured in the Aspire
Pagination query string parameters Expand query string parameters: connector, workflows, server, policies
Response
Status | |||||||||||||||||||||
Response code | Description | ||||||||||||||||||||
200 | Success | ||||||||||||||||||||
Section | |||||||||||||||||||||
Status: 200 Get all seeds, filteredLists seeds configured in the Aspire, filtered by a specified criteria
Pagination query string parameters Expand query string parameters: connector, workflows, server, policies |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single seedGet information about a single seed configured in Aspire
Expand query string parameters: connector, workflows, server, policies Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | |||||||||||||||||||
404 | The given seed id was not found |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seedsAdd seeds to Aspire
Body Parameters
Example
Response
Status | Response code | Description
See Response Body for details
regarding the response body returned where multiple items are affected with some (or all) returning errors Status: 201, 406 |
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seed(s)Update seeds in Aspire.
Path Parameters
Body Parameters
+ fields from "Add" section... Example for more seeds
Response
Status | |||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||
404 | Not found - a given seed identifier was not found | 406 | Not acceptable - there was an issue validating the input
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seeds, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
Filters: Check the The seed filter definition here
Status: 200, 406 |
Section | |||||||
---|---|---|---|---|---|---|---|
Delete multiple seeds, filteredDelete multiple seeds from Aspire, filtered by a specified criteria
Body Parameters | |||||||
Name | Type | Required | Description | filter | JSON | Required | Filters retrieved seeds. Check the
Code Block | ||
---|---|---|
| ||
{ "message": "optionaldelete result response message" } |
: 200
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete seed(s)Delete one or more seeds from Aspire.
Path Parameters and query parameters
Body parameters
Example
Response
| |||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||
404 | Not found - a given seed identifier was not found | ||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Crawl controlStart, stop, pause and resume crawls of one or more seeds.
Path Parameters
Query String Parameters
Examples Starts an incremental crawl for a single seed
Starts an full crawl for a single seed
Pauses a crawl for a single seed
Starts a crawl for multiple seeds
Starts a crawl for multiple seeds (alternative)
Response
Status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given seed identifier was not found | 406 | Not acceptable - there was an issue validating the input
"
} |
Status: 200, 404, 406
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Re-balance seed allocation (TODO)Allows an administrator to manually re-balance the seed to manager allocation for active crawls
| ||||||||||||
Response code | Description | |||||||||||
200 | Success | |||||||||||
404 | The given batch id was not found |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get seed type dxf (TODO)Returns the dxf for a specific seed type
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | 404 | Not found - a given service identifier was not found
Section | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|