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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body Parameters
Example
Get a single seedGet information about a single seed configured in Aspire
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", "seed": "c:\\testdata\\2500", "prioritythrottlePolicy": "mediumthrottlePolicyId", "checksumroutingPolicies": "499207DDF2E673B3B33D74566D7457B5"["routingPolicyId1", "routingPolicyId2"], "crawldeleteIncrementalPolicy" : {"deletePolicyId" .... }, { "managerseed": "manager_192.168.188.55:50505//AAABc8Mnl84="\\Directory2", "modeconnector": "fullconnectorId", "phaseconnection": "crawlStartconnectionId", "statetype": "runningfilesystem", .... "startroutingPolicies": 1596707252548 }, "properties": { This will be a dynamic JSON object } } } |
Status
Add seeds to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds |
Body Parameters
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds
[{
"seed":"\\Directory1",
"connector":"connectorId",
"server":"serverId",
"type":"filesystem",
....
},
{
"seed":"\\Directory2",
"connector":"connectorId",
"server":"serverId",
"type":"filesystem",
....
"policies": ["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",
"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
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
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 seed(s)Update seeds in Aspire.
Path Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the seed to update | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the seed to update | ... see parameters for Add seed |
Filters: The seed filter definition here
|
Example for more seeds
Code Block | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
PUT /aspire/_api/seeds
{
"AAABcID5GBc="
|
Response
Code Block | ||
---|---|---|
| ||
{
"seed": [{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem",
"status": "N"
},
{
"id": "AAABcIueWUc=",
"type": "filesystem",
"seed": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policies": ["policy_1"],
"workflows": ["workflow_1","workflow_99"]
"status": "N"
},
"properties": { This will be a dynamic JSON object }]
} |
Status
Section | |||||||||
---|---|---|---|---|---|---|---|---|---|
Update seeds, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
Filters: Check the seed filter definition here
|
|
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 | ||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||
Delete multiple seeds, filteredDelete multiple seeds from Aspire, filtered by a specified criteria
Body Parameters
Response
Status | ||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||
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
Delete seed(s)Delete one or more seeds from Aspire.
Path Parameters and query parameters | ||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||
id | string | Required | The identifier(s) of the seed(s) to delete | |||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||
ids | string | Required | The identifier(s) of the connector(s) to delete |
191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full |
Reprocess only errored documents from the previous crawl
Code Block | ||||
---|---|---|---|---|
| ||||
DELETEPOST /aspire/_api/seeds/AAABcID5GBc= POST /aspire/_api/seeds { "ids":["id1","id2"] } 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 seedsResponse
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds/control [{{ "messageid": "optional response message"AAABcID5GBc=" }, { "id": "AAABcIueWUc=" } |
Status
] |
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
Crawl controlStart, stop, pause and resume crawls of one or more seeds.
Path Parameters | |||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier(s) of the seed(s) to control | ||||||||||||||||||||||||||||||||||||||||
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 |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control |
Starts an full crawl for a single seed
Code Block | ||
---|---|---|
| ||
POSTexport/AAABcID5GBc DELETE /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full |
Pauses a crawl for a single seed
Code Block | ||
---|---|---|
| ||
export?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pauseexport { "ids":["AAABcID5GBc","AAABcID5GBd"] } |
ResponseStarts a crawl for multiple seeds
Code Block | ||||
---|---|---|---|---|
| ||||
{ "export": POST /aspire/_api/seeds/control [{ "idseeds": "AAABcID5GBc=" }, { { "seed": [ { "id": "AAABcIueWUc=<seed_id>" }] |
Starts a crawl for multiple seeds (alternative)
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds/control
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
,
"type": "rest-api",
"description": "REST",
"connector": "<connector_id>",
"seed": "N\/A",
"priority": "medium",
"checksum": "eb4b51659226093casdf3854sdf8f67e4f0de8217c0fd86ea565ce0",
"connection": "<connection_id>",
"properties": {
"seed": "N\/A",
"crawlRules": [
{
"conditionalScript": false,
"entityType": "root",
"shouldStop": false,
...
}
],
"stopOnScannerError": true
}
},
...
]
},
"connectors": {
"connector": [
{
"id": "<connector_id>",
"artifact": "com.accenture.aspire:aspire-rest-source",
"type": "rest-api",
"description": "RestConnector",
"properties": {
"debug": false,
"wDebug": false,
...
},
"checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
},
...
]
},
"credentials": {
"credential": [
{
"id": "<credential_id>",
"type": "rest-api",
"description": "RestCredentials",
"properties": {
"type": "bearer",
"query": {
...
}
}
},
...
]
},
"connections": {
"connection": [
{
"id": "<connection_id>",
"type": "rest-api",
"description": "RestConnection",
"credential": "<credential_id>",
"properties": {
"maxRetries": 3,
"useThrottling": false,
"throttling": "throttling_false",
"useProxy": false,
"proxy": "proxy_false",
"trustAllCertificates": false,
...
}
},
...
]
},
"policies": {
"policy": [
{
"id": "<policy_id>",
"type": "throttle",
"description": "pT",
"period": "day",
"value": 1
},
...
]
},
"schedules": {
"schedule": [
{
"id": "<schedule_id>",
"type": "time",
"description": "test",
"enabled": "false",
"scheduleTimeType": "daily",
"stopOnFail": false,
"schedule": "0 0 0 1\/1 * ?",
"after": null,
"seeds": "<seed_id>",
"crawlMode": "full",
"completeThreshold": 1.0,
"action": "pause"
},
...
]
},
"workflows": {
"workflow": [
{
"id": "<workflow_id>",
"type": "connector",
"description": "myWorkFlow",
"checksum": "dc7d632e4fac3aed7404d2c260sd3f54eea266f9fd4af73b6251d6cb",
"templates": {
...
},
"events": {
"event": [
...
]
},
"rules": {
"rule": [
...
]
}
},
...
]
}
}
} |
Status: 200, 404, 406
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export multiple seeds, filteredExport multiple seeds from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.
Filters: The connection filter definition here Response
Status: 200 |
Section | |||||||
---|---|---|---|---|---|---|---|
ImportThe import usage can be found here | |||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
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
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|