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
Table of Contents |
---|
Section | |||||||
---|---|---|---|---|---|---|---|
Get all seedsLists all the seeds configured in the Aspire
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Indicates the initial page to be retrieved | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted | ||||
sortMode | string | Optional | Sort mode
| ||||
expand | string | Optional | List of fields to expand, * will expand everything |
Code Block | ||
---|---|---|
| ||
{ "seed": [ { "id": "191283d9-183e-4820-8932-32b1fa07d2d5", "description": "2500 test", "seed": "c:\\testdata\\2500", "connector": { "id": "accd3396-6004-47c9-80a6-d6ae283878f5", "description": "NetApp Connector", "type": { "id": "filesystem", "name": "File System" }, "created": 1596707252548, "updated": 1596707252548 }, "workflow": { "id": "accd3396-4820-8932-80a6-f57191283d98", "description": "My workflow", "type": "connector", "created": 1596707252548, "updated": 1596707252548 }, "priority": "medium", "tags": [ "UK", "GE", "FR" ], "checksum": "499207DDF2E673B3B33D74566D7457B5", "crawl": { "manager": "manager_192.168.188.55:50505//AAABc8Mnl84=", "mode": "full", "phase": "crawlStart", "state": "running", "start": 1596707252548, "next": 1596707252548 }, "properties": { This will be a dynamic JSON object } }, { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "seed": "c:\\testdata\\2500", "connector": { "id": "accd3396-6004-47c9-80a6-d6ae283878f5", "description": "NetApp Connector", "type": { "id": "filesystem", "name": "File System" }, "created": 1596707252548, "updated": 1596707252548 }, "workflow": { "id": "accd3396-4820-8932-80a6-f57191283d98", "description": "Stager Workflow", "type": "connector", "created": 1596707252548, "updated": 1596707252548 }, "priority": "medium", "checksum": "5647E40827A6C09CBA868294BB437CE5", "crawl": { "phase": "idle", "state": "never" }, "properties": { This will be a dynamic JSON object } } ] } |
Status
Response code | Description |
---|---|
200 | Success |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all seeds, filteredLists seeds configured in the Aspire, filtered by a specified criteria
Query String Parameters
Pagination query string parameters Common filter (TODO specific filter here) TODO: expand here! Query String Parameters
Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single seedGet information about a single seed configured in Aspire
Path Parameters
Query String Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seedsAdd seeds to Aspire
Body Parameters
Example
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update seedsUpdate seeds in Aspire.
Body Parameters
Example
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple seeds, filteredDelete multiple seeds from Aspire, filtered by a specified criteria
Body Parameters
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single seedDelete one or more seeds from Aspire.
Path Parameters
Example
Response
Status
|
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
|
Section | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Re-balance seed allocationAllows an administrator to manually re-balance the seed to manager allocation for active crawls
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get seed type dxf (TODO)Returns the dxf for a specific seed type
Path Parameters
Response
Status
|
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
|