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 | ||||
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
|
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 }, "descriptionseed": "2500 test", [ "seed": "c:\\testdata\\2500", { "connector": { "id": "accd3396b4adeb8c-60043deb-47c94379-80a6ad52-d6ae283878f5e2a8d219a84a", "descriptiontype": "NetApp Connectorfilesystem", "typedescription": {"pepoSeed", "idconnector": "filesystem16e901a5-75c7-4969-90d2-70ad299916f3", "nameseed": "File SystemDirectory1", }, "createdpriority": 1596707252548"medium", "updatedchecksum": 1596707252548 "11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40", }, "workflowcrawl": { "id": "accd3396-4820-8932-80a6-f57191283d98", "descriptionmanager": "My workflowmanager_192.168.0.16:40505//AAABeOQLewo=", "type": "connector", "createdmode": 1596707252548"full", "updated": 1596707252548 "phase": "idle", }, "prioritystate": "mediumcompleted", "tags": [ "UKstart": 1618736207176, "GE", "FRend": 1618736273635 ]}, "checksumconnection": "499207DDF2E673B3B33D74566D7457B598960f72-aab0-4ba1-a90e-b29d4e3c2c92", "crawl": { "managerworkflows": "manager_192.168.188.55:50505//AAABc8Mnl84=",72022651-c2f4-45a9-9e18-2b0ace529cda" "mode": "full",} "phase": "crawlStart", "state": "running", ] } |
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
Query String Body Parameters
Body Parameters | |||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||
filter | JSON | Required | Filters retrieved seeds. Check the filter definition here |
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 |
ExampleResponse
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/seeds [{ { "seed": [ { "id": "191283d9-183e-4820-8932-32b1fa07d2d5", "description": "2500 test"\\Directory1", "connector":"connectorId", "connection":"connectionId", "type":"filesystem", "seedthrottlePolicy": "c:\\testdata\\2500throttlePolicyId", "connectorroutingPolicies": { ["routingPolicyId1", "routingPolicyId2"], "iddeleteIncrementalPolicy" : "accd3396-6004-47c9-80a6-d6ae283878f5",deletePolicyId" .... }, { "seed":"\\Directory2", "descriptionconnector": "NetApp ConnectorconnectorId", "type": {"connection":"connectionId", "id"type": "filesystem", .... "routingPolicies": ["policy_1"], "nameworkflows": ["workflow_1","workflow_99"] }] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "seed": [{ "File System" }, "createdid": 1596707252548"5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "updatedconnector": 1596707252548 "accd3396-6004-47c9-80a6-d6ae283878f5", }"seed": "c:\\testdata\\2500", "workflowpriority": {"medium", "idchecksum": "accd3396-4820-8932-80a6-f57191283d985647E40827A6C09CBA868294BB437CE5", "descriptioncrawl": "My workflow", { "typephase": "connectoridle", "createdstate": 1596707252548,"never" } "updated": 1596707252548 }, { }"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3", "priorityconnector": "mediumconnector_1", "tagsdescription": [ "UK"250,000 files", "GE"credential": "cred_1", "FR" ]"throttlePolicy": "policy_1", "checksumworkflow": ["499207DDF2E673B3B33D74566D7457B5workflow_1", "workflow_99"] "crawlseed": {"c:\\testdata\\25000", "managerpriority": "manager_192.168.188.55:50505//AAABc8Mnl84=medium", "modechecksum": "full5647E40827A6C09CBA868294BB437CE5", "crawl": { "phase": "crawlStartidle", "state": "runningnever", } }, "startproperties": 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} |
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
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Get a single seedGet information about a single seed configured in Aspire
Path Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The id of the seed to return |
Filters: The seed filter definition here
|
Response
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"seed"
|
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. Add seedsAdd seeds to Aspire
Body Path Parameters and query parameters
Body parameters
Example
Example
Response
Response
Status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Update seedsUpdate seeds in Aspire.
Body Parameters
Examples 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 |
| ||||
GET /aspire/_api/seeds/export/AAABcID5GBc
DELETE /aspire/_api/seeds/export?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/seeds/export
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"export": {
"seeds": {
"seed": [
{
|
Example
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/seeds { "AAABcID5GBc=": { "id": "AAABcID5GBc=<seed_id>", "seed": "c:\\testdata\\2500", "type": "filesystemrest-api", }, "AAABcIueWUc=": { "iddescription": "AAABcIueWUc=REST", "seed": "c:\\testdata\\250000", "connector": "connector<connector_1id>", "description": "250,000 files", "credentialseed": "cred_1N\/A", "policy": "policy_1", "workflowpriority": ["workflow_1medium","workflow_99"] } } |
Response
Code Block | ||
---|---|---|
| ||
{ "seed": [{ "idchecksum": "AAABcID5GBc=eb4b51659226093casdf3854sdf8f67e4f0de8217c0fd86ea565ce0", "seed": "c:\\testdata\\2500", "typeconnection": "filesystem<connection_id>", "status": "N" }, "properties": { "id": "AAABcIueWUc=", "type": "filesystem", "seed": "c:\\testdata\\250000N\/A", "connector": "connector_1", "descriptioncrawlRules": "250,000 files",[ "credential": "cred_1", "policy": "policy_1", { "workflow "conditionalScript": ["workflow_1","workflow_99"] false, "statusentityType": "Nroot", }, "propertiesshouldStop": {false, This will be a dynamic JSON object }] } |
Status
...
}
],
"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 | ||||
---|---|---|---|---|
| ||||
|
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
Delete one or more seeds from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/seeds/AAABcID5GBc%3D |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Start, stop, pause and resume crawls of one or more seeds.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Query String Parameters
The action to perform:
Defaults to start if not specified
The type of crawl to start:
Defaults to incremental if not specified
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 |
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 | ||
---|---|---|
| ||
PUT /aspire/_api/seeds/control
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Allows an administrator to manually re-balance the seed to manager allocation for active crawls
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: Credentials Seed filter:
|