The configuration and control 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. 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
Table of Contents |
---|
Easy Heading Free | ||||
---|---|---|---|---|
|
Section |
---|
Get all |
Section | ||||||||
---|---|---|---|---|---|---|---|---|
List seedsLists all the seeds configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Query String Parameters | ||||||||
Name | Type | Required | Description | |||||
state | string | Optional | Filter returned seeds to only those with the given status(es) | |||||
type | string | Optional | Filter returned seeds to only those with the given type | |||||
description | string | Optional | Filter returned seeds to only those whose description matches the given expression |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all seeds, filteredLists seeds configured in the Aspire, filtered by a specified criteria, 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, connection, policies |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "seedcount": [{ "idtotalItems": "AAABcID5GBc=",1 "seed": "c:\\testdata\\2500"}, "typeseed": "filesystem", [ "description": "2,500 files", { "status": "S", "startid": 1584550193011"b4adeb8c-3deb-4379-ad52-e2a8d219a84a", "stop": 1584550267047 }, { "idtype": "AAABcIueWUc=filesystem", "seed": "c:\\testdata\\250000", "typedescription": "filesystempepoSeed", "description": "250,000 files", "statusconnector": "S16e901a5-75c7-4969-90d2-70ad299916f3", "stopseed": 1583240224684"Directory1", "start "priority": 1583239823374 }], "medium", "messagechecksum": "optional response message" } |
Status
Get information about a single seed configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String and Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "seed": { "id": "AAABcID5GBc"11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40", "crawl": { "manager": "manager_192.168.0.16:40505//AAABeOQLewo=", "seed": "c:\\testdata\\2500", "typemode": "filesystemfull", "description "phase": "2,500 filesidle", "status "state": "Scompleted", "start": 15845501930111618736207176, "stop": 1584550267047 }, "message": "optional response message" } |
Status
"end": 1618736273635
},
"connection": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
"workflows": "72022651-c2f4-45a9-9e18-2b0ace529cda"
}
]
} |
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Add seed(s)Add one or more seeds to Aspire
Expand query string parameters: connector, workflows, connection, policies Path Request Body Parameters
Examples Add a single seed
Response
Add multiple seeds
Response
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
"workflows": "72022651-c2f4-45a9-9e18-2b0ace529cda"
} |
Status: 200, 404
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seed(s)Add seeds to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update seed(s)Update one or more seeds in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
Request Body Parameters
Examples Update a single seed
Example
Update multiple seeds
Response
Status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given seed identifier was not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
"crawl": {
"phase": "idle",
"state": "never"
}
},
"properties": { This will be a dynamic JSON object }]
} |
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.
| |||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||
Delete seed(s)Delete one or more seeds from Aspire.
Examples Delete a single seed
Delete multiple seeds
Delete multiple seeds (alternative form)
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 |
Start, stop, pause and resume crawls of one or more seeds.
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire_api/seeds/crawl POST /aspire_api/seeds/crawl/:action POST /aspire_api/seeds/crawl/:action/:type |
Query String, Path and Request Body Objects
The action to perform:
Defaults to start if not specified
The type of crawl to start:
Defaults to incremental if not specified
Examples
Starts a crawl for a single seed
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Starts a crawl for multiple seeds
Code Block | ||
---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Starts a crawl for seeds (alternative form)
Code Block | ||
---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|