Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
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
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all seedsLists all the seeds configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters Sorting query string parameters Expand query string parameters: connector, workflows, serverconnection, policies
Response
Status: 200 |
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single seedGet information about a single seed configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Expand query string parameters: connector, workflows, connection, policies Path Parameters
Response
Status: 200 | ||||||||||||||||||||||
Section | ||||||||||||||||||||||
Get a single seedGet information about a single seed configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Expand query string parameters: connector, workflows, server, policies Path Parameters | ||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||
id | string | Required | The id of the seed to return |
Code Block | ||
---|---|---|
| ||
{ "seed": { "id": "191283d9-183e-4820-8932-32b1fa07d2d5", "connector": "accd3396-6004-47c9-80a6-d6ae283878f5"state": "completed", "start": 1618736207176, "end": 1618736273635 }, "connection": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92", "seed": "c:\\testdata\\2500", "priority": "medium", "checksumworkflows": "499207DDF2E673B3B33D74566D7457B5",72022651-c2f4-45a9-9e18-2b0ace529cda" "crawl": { "manager": "manager_192.168.188.55:50505//AAABc8Mnl84=", "mode": "full", "phase": "crawlStart", "state": "running", "start": 1596707252548 }, "properties": { This will be a dynamic JSON object } } } |
Status: 200, 404
} |
Status: 200, 404
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seed(s)Add seeds to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Add seed(s)Add seeds to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
Example
Example
Response
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, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
x - at least one field must be present Example for more seeds
Response
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors Status: 200, 404, 406 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seeds, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Filters: The seed filter definition here
Status: 200, 406 |
Response
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete seed(s)Delete one or more seeds from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters and query parameters
Body parameters
Example
Response
Status: 200, 404, 406
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Crawl controlStart, stop, pause and resume crawls of one or more seeds, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Query String Parameters
Body Optionally, a filter can be added to specify which seeds to start Examples Starts an incremental crawl for a single seed
Starts an full crawl for a single seed
Reprocess only errored documents from the previous crawl
Pauses a crawl for a single seed
Starts a crawl for multiple seeds
Starts a crawl for multiple seeds (alternative)
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export seed(s)Export one or more seed from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section | |||||||
---|---|---|---|---|---|---|---|
ImportThe import usage can be found here | |||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Filters: The seed filter definition here
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200
Delete one or more seeds from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
borderColor | black |
---|---|
bgColor | #fafafb |
DELETE /aspire/_api/seeds/:id
DELETE /aspire/_api/seeds
POST /aspire/_api/seeds/delete
Path Parameters and query parameters
Body parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/seeds/AAABcID5GBc
DELETE /aspire/_api/seeds?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/seeds/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Start, stop, pause and resume crawls of one or more seeds, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Query String Parameters
The action to perform:
Defaults to start if not specified
The type of crawl to start:
Defaults to incremental if not specified
Examples
Starts an incremental crawl for a single seed
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control |
Starts an full crawl for a single seed
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full |
Pauses a crawl for a single seed
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pause |
Starts a crawl for multiple seeds
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/control
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Starts a crawl for multiple seeds (alternative)
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/control
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status: 200, 404, 406
Allows an administrator to manually re-balance the seed to manager allocation for active crawls
Panel | ||||
---|---|---|---|---|
| ||||
|
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status: 200, 404
Returns the dxf for a specific seed type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/seeds/type/:typeId/dxf |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status: 200, 404
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|