The configuration and control API provides functionality that allows a administrator to perform actions such as adding a seed to crawl, or beginning or stopping a crawl. This API will provide the functionality required by the Aspire User interface and will be extensively used by it. The API will also be used by any external process (or script) that needs to control Aspire
Seed API
List seeds
Lists all the seeds configured in the Aspire
GET /aspire_api/seeds
Parameters
| Name | Type | Description |
|---|---|---|
| state | string | Filter returned seeds to only those with the given status(es) |
| type | string | Filter returned seeds to only those with the given type |
| description | string | Filter returned seeds to only those whose description matches the given expression |
| seed | string | Filter returned seeds to only those whose seed matches the given expression |
Response
{
"seed": [{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem",
"description": "2,500 files",
"status": "S",
"start": 1584550193011,
"stop": 1584550267047
},
{
"id": "AAABcIueWUc=",
"seed": "c:\\testdata\\250000",
"type": "filesystem",
"description": "250,000 files",
"status": "S",
"stop": 1583240224684,
"start": 1583239823374
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
Get a single seed
Get information about a single seed configured in Aspire
GET /aspire_api/seeds/:seed_id
Response
{
"seed": {
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem",
"description": "2,500 files",
"status": "S",
"start": 1584550193011,
"stop": 1584550267047
},
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given seed id was not found |
Add seed(s)
Add one or more seeds to Aspire
POST /aspire_api/seeds
Request Body Objects
| Name | Type | 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 | An optional description of the seed |
| credential | string | An optional id of the credential to use for this seed |
| policy | string | An optional list of the policy identifiers to use for this seed |
| workflow | string | An optional list of the workflow identifiers to use for this seed |
Examples
Add a single seed
{
"seed": "c:\\testdata\\2500",
"type": "filesystem"
}
Add multiple 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
{
"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",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"status": "N"
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 406 | Not acceptable - there was an issue validating the input |
Update seed(s)
Update 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
PUT /aspire_api/seeds
Request Body Objects
| Name | Type | 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 | An optional description of the seed |
| credential | string | An optional id of the credential to use for this seed |
| policy | string | An optional list of the policy identifiers to use for this seed |
| workflow | string | An optional list of the workflow identifiers to use for this seed |
Examples
Update a single seed
{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem"
}
Update multiple seeds
[{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem"
},
{
"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
{
"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",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"status": "N"
}],
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 201 | Created |
| 404 | Not found - a given seed identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Delete seed(s)
Delete one or more seeds from Aspire.
DELETE /aspire_api/seeds
Request Body Objects
| Name | Type | Description |
|---|---|---|
| id | string | Required: The identifier(s) of the seed(s) to delete |
Examples
Delete a single seed
{
"id": "AAABcID5GBc="
}
Update multiple seeds
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}]
Update multiple seeds (alternative form)
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
}
Response
{
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | Not found - a given seed identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Status API
Crawl Control API
Connector API
Credential API
Policy API
Workflow API
Schedule API
Overview
Content Tools
Copyright © 2024 Accenture
