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
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 | ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
Section | ||||||||||||||||||||||
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add seed(s)Add seeds to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. 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 |
Panel | ||||
---|---|---|---|---|
| ||||
|
Expand query string parameters: connector, workflows, server, policies
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"seed": {
"id": "191283d9-183e-4820-8932-32b1fa07d2d5",
"connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
"seed": "c:\\testdata\\2500",
"priority": "medium",
"checksum": "499207DDF2E673B3B33D74566D7457B5",
"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
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
seed | string | Required | The url/path indicating the content to crawl |
type | string | Required | The type of connector to use for this seed (may be omitted if connector is specified) |
connector | string | Required | The identifier of the connector configuration to use for this seed (may be omitted if type is specified) - see Connectors API |
description | string | Required | An description of the seed |
connection | string | Required | a connection id - see Connections API |
credential | string | Optional | An optional id of the credential to use for this seed - see Credentials API |
throttlePolicy | string | Optional | a throttle policy id - see Policies API |
routingPolicies | string | Optional | An optional list of the routing policy identifiers to use for this seed - see Policies API |
deleteIncrementalPolicy | string | Optional | (from 5.0.2) A delete policy - see Policies API |
workflows | string | Optional | An optional list of the workflow identifiers to use for this seed - see Workflow API |
tags | string | Optional | An optional list of the tags to use for this seed |
properties | object | Optional | Seed properties |
Example
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds
[{
"seed":"\\Directory1",
"connector":"connectorId",
"connection":"connectionId",
"type":"filesystem",
"throttlePolicy": "throttlePolicyId",
"routingPolicies": ["routingPolicyId1", "routingPolicyId2"],
"deleteIncrementalPolicy" : "deletePolicyId"
....
},
{
"seed":"\\Directory2",
"connector":"connectorId",
"connection":"connectionId",
"type":"filesystem",
....
"routingPolicies": ["policy_1"],
"workflows": ["workflow_1","workflow_99"]
}] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"seed": [{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
"connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
"seed": "c:\\testdata\\2500",
"priority": "medium",
"checksum": "5647E40827A6C09CBA868294BB437CE5",
"crawl": {
"phase": "idle",
"state": "never"
}
},
{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"throttlePolicy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"seed": "c:\\testdata\\25000",
"priority": "medium",
"checksum": "5647E40827A6C09CBA868294BB437CE5",
"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.
Body Parameters
x - at least one field must be present Example for more seeds
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | The given seed id was not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds |
Body Parameters
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds
[{
"seed": "c:\\testdata\\2500",
"type": "filesystem"
},
{
"seed": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
}] |
Response
Code Block | ||
---|---|---|
| ||
{
"seed": [{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
"connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
"seed": "c:\\testdata\\2500",
"priority": "medium",
"checksum": "5647E40827A6C09CBA868294BB437CE5",
"crawl": {
"phase": "idle",
"state": "never"
}
},
{
"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"seed": "c:\\testdata\\25000",
"priority": "medium",
"checksum": "5647E40827A6C09CBA868294BB437CE5",
"crawl": {
"phase": "idle",
"state": "never"
}
},
"properties": { This will be a dynamic JSON object }]
} |
Status
Update seeds in Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Example
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "seedconnector": "c:\\testdata\\2500connector_2", "type": "filesystem" }, "AAABcIueWUc=": { "id": "AAABcIueWUc=", "seed": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credentialroutingPolicies": "cred_1", "policy": "["policy_1"], "workflowworkflows": ["workflow_1","workflow_99"] } } |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "seed": [{ "updated":true,"id": "AAABcID5GBc="}, "seed": "c:\\testdata\\2500", "type": "filesystem", "status": "N" }, { "id": "AAABcIueWUc=", "type": "filesystem", "seed": "c:\\testdata\\250000", "connector": "connector_1",{"updated":true,"id":"AAABcID5GBd="}]} |
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
Delete multiple seeds from Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Status: 200, 406 |
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete seed(s)Delete one or more seeds from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
| ||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||
404 | Not found - a given credential identifier was not found | |||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||
Delete single seedDelete one or more seeds from Aspire.
Path Parameters | ||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||
id | string | Required | The identifier(s) of the seed(s) to delete |
Code Block | ||
---|---|---|
| ||
DELETE
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
|
Path Parameters and query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed(s) to delete |
Body parameters
Name | Type | Required | Description |
---|---|---|---|
ids |
Start, stop, pause and resume crawls of one or more seeds.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seedconnector(s) to controldelete |
Query String ParametersExample
NameCode Block |
---|
|
|
|
The action to perform:
Defaults to start if not specified
The type of crawl to start:
Defaults to incremental if not specified
| |
DELETE |
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 //AAABcID5GBc DELETE /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full |
Pauses a crawl for a single seed
Code Block | ||
---|---|---|
| ||
?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pausedelete { "ids":["AAABcID5GBc","AAABcID5GBd"] } |
ResponseStarts a crawl for multiple seeds
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/control [{ "idmessage": "AAABcID5GBc=" }, { "id": "AAABcIueWUc=" }] |
Starts a crawl for multiple seeds (alternative)
delete result response message"
} |
Status: 200, 404, 406
Section | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Delete multiple seeds, filteredDelete multiple seeds from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
| ||||||||||
Code Block | ||||||||||
| ||||||||||
PUT
Filters: The seed filter definition here Response
|
: 200 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
404 | Not found - a given seed identifier was not found | |||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||
Crawl controlStart, stop, pause and resume crawls of one or more seeds, this endpoint need the at least the OPERATOR role to be executed. | ||||||||||||
Section | ||||||||||||
Re-balance seed allocationAllows an administrator to manually re-balance the seed to manager allocation for active crawls
Status | ||||||||||||
Response code | Description | |||||||||||
200 | Success | |||||||||||
404 | The given batch id was not found |
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the seed(s) to control |
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
action | string | Optional | The action to perform:
Defaults to start if not specified |
type | string | Optional | The type of crawl to start:
Defaults to incremental if not specified |
Body
Optionally, a filter can be added to specify which seeds to start
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 |
Reprocess only errored documents from the previous crawl
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=reprocess |
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
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 | |||||||
Get seed type dxf (TODO)Returns the dxf for a specific seed type
Path Parameters | |||||||
Name | Type | Required | Description | ||||
typeId | string | Required | Id of the type of the seed |
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|