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.
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": "191283d9-183e-4820-8932-32b1fa07d2d5",1 }, "connectorseed": "accd3396-6004-47c9-80a6-d6ae283878f5",[ "seed": "c:\\testdata\\2500", { "priorityid": "mediumb4adeb8c-3deb-4379-ad52-e2a8d219a84a", "checksum "type": "499207DDF2E673B3B33D74566D7457B5filesystem", "crawl "description": { "pepoSeed", "managerconnector": "manager_192.168.188.55:50505//AAABc8Mnl84=16e901a5-75c7-4969-90d2-70ad299916f3", "modeseed": "fullDirectory1", "phasepriority": "crawlStartmedium", "statechecksum": "running11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40", "startcrawl": 1596707252548{ } }, { "idmanager": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3manager_192.168.0.16:40505//AAABeOQLewo=", "connector": "accd3396-6004-47c9-80a6-d6ae283878f5", "seedmode": "c:\\testdata\\2500full", "priority": "medium", "checksum "phase": "5647E40827A6C09CBA868294BB437CE5idle", "crawlstate": { "completed", "phase "start": "idle"1618736207176, "stateend": "never" 1618736273635 }, } ], "messageconnection": "optional response message"98960f72-aab0-4ba1-a90e-b29d4e3c2c92", "workflows": "72022651-c2f4-45a9-9e18-2b0ace529cda" } ] } |
: 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 Path Parameters
Response
Status | ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
404 | The given seed id was not found |
full",
"phase": "idle",
"state": "completed",
"start": 1618736207176,
"end": 1618736273635
},
"connection": "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.
Body Parameters
Example
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Add seedsAdd one or more seeds to Aspire
Request 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) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Optional | An optional description of the seed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
credential | string | Optional | An optional id of the credential to use for this seed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policy | string | Optional | An optional list of the policy identifiers to use for this seed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
workflow | string | Optional | An optional list of the workflow identifiers to use for this seed |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds
{
"seed": "c:\\testdata\\2500",
"type": "filesystem"
} |
Add multiple seeds
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", "connectorroutingPolicies": "accd3396-6004-47c9-80a6-d6ae283878f5"["routingPolicyId1", "routingPolicyId2"], "seeddeleteIncrementalPolicy" : "c:\\testdata\\2500",deletePolicyId" "priority.... }, { "seed": "medium\\Directory2", "checksumconnector": "5647E40827A6C09CBA868294BB437CE5connectorId", "crawlconnection": {"connectionId", "phasetype": "idlefilesystem", .... "stateroutingPolicies": ["neverpolicy_1"], "workflows": ["workflow_1","workflow_99"] }] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "seed": [ } }, { "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "connector": "connector_1accd3396-6004-47c9-80a6-d6ae283878f5", "descriptionseed": "250,000 filesc:\\testdata\\2500", "credentialpriority": "cred_1medium", "policychecksum": "policy_15647E40827A6C09CBA868294BB437CE5", "workflowcrawl": ["workflow_1","workflow_99"] { "seedphase": "c:\\testdata\\25000idle", "prioritystate": "mediumnever", "checksum": "5647E40827A6C09CBA868294BB437CE5"} }, "crawl": { "phaseid": "idle5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "stateconnector": "neverconnector_1", "description": } }]"250,000 files", "credential": "cred_1", "messagethrottlePolicy": "optional response message" } |
Status
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
Update seedsUpdate 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the seed to update | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Optional | An optional description of the seed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
credential | string | Optional | An optional id of the credential to use for this seed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policy | string | Optional | An optional list of the policy identifiers to use for this seed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
workflow | string | Optional | An optional list of the workflow identifiers to use for this seed |
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds/AAABcID5GBc%3D
{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem"
} |
Update multiple seeds
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem"
},
"AAABcIueWUc=": {
"id": "AAABcIueWUc=",
"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": "AAABcID5GBc=", "seedconnector": "c:\\testdata\\2500connector_2", }, "typeAAABcIueWUc=": "filesystem",{ "statusid": "NAAABcIueWUc=", }, { "connector": "connector_1", "iddescription": "AAABcIueWUc=250,000 files", "typeroutingPolicies": ["filesystempolicy_1"], "seedworkflows": "c:\\testdata\\250000", "connector": "connector_1", "description": "250,000 files", "credential": "cred_1", "policy": "policy_1", "workflow": ["workflow_1","workflow_99"] "status": "N" }], "message": "optional response message" } |
Status
["workflow_1","workflow_99"]
}
} |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{"seed":[{"updated":true,"id":"AAABcID5GBc="},{"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
Delete one or more seeds from Aspire.
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. |
|
Path and Query String Parameters
Examples
Delete a single seed
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/seeds/AAABcID5GBc%3D |
Delete multiple seeds
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/seeds?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Filters: The seed filter definition here
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.
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:
| |||||||||||||
Section | |||||||||||||
Crawl controlStart, stop, pause and resume crawls of one or more seeds.
Path, Query String and Request Body Objects | |||||||||||||
Name | Type | Required | Description | ||||||||||
id | string | Required | The identifier(s) of the seed(s) to control | ||||||||||
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 |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/AAABcID5GBc%3D |
Starts an full crawl for a single seed
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/AAABcID5GBc%3D/start/full |
Pauses a crawl for a single seed
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/AAABcID5GBc%3D/pause |
Starts a crawl for multiple seeds
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds/crawl
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Starts a crawl for multiple seeds (alternative)
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status