The connector connectors API provides functionality that allows a administrator or operator to perform actions such as adding and configuring connectors.
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
List Get all connectorsLists all the seeds connectors 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 | ||||
seed | string | Optional | Filter returned seeds to only those whose seed matches the given expression |
connectors |
Pagination query string parameters
Sorting query string parameter
Section | |||||||
---|---|---|---|---|---|---|---|
Get all connectors, filteredLists connectors 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 |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"count": {
"totalItems": 2
} |
Response
Code Block | ||
---|---|---|
| ||
{ "seed": [{ "id": "AAABcID5GBc=", "seed": "c:\\testdata\\2500", "typeconnector": "filesystem", [ "description": "2,500 files", { "status": "S", "startid": 1584550193011"948a9d99-5b71-4023-976e-14dcdc82f231", "stop": 1584550267047 }, { "idartifact": "AAABcIueWUc=com.accenture.aspire:aspire-ldap-cache-source", "seed": "c:\\testdata\\250000", "type": "filesystemldap", "description": "250,000 files", "statusdescription": "SLDAP", "stop": 1583240224684, "startproperties": 1583239823374 }], "message": "optional response message" } |
Status
Get information about a single seed configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String and Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"seed": {
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem",
"description": "2,500 files",
"status": "S",
"start": 1584550193011,
"stop": 1584550267047
},
"message": "optional response message"
} |
Status
{
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
....
},
"checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
},
{
"id": "16e901a5-75c7-4969-90d2-70ad299916f3",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
....
},
"checksum": "0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62"
}
]
} |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single connectorGet information about a single connector configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
Example
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 connector(s)Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
x - at least one field must be present
Example - update more connectors
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete connector(s)Delete one or more connectors from Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export connector(s)Export one or more connector 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
Connector filter:
| |||||||||||||
Response code | Description | ||||||||||||
200 | Success | ||||||||||||
404 | The given seed id was not found | ||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire_api/seeds |
Request Body Parameters
Examples
Add a single seed
Code Block | ||
---|---|---|
| ||
{
"seed": "c:\\testdata\\2500",
"type": "filesystem"
} |
Add multiple seeds
Code Block | ||
---|---|---|
| ||
[{
"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": "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
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
Panel | ||||
---|---|---|---|---|
| ||||
PUT /aspire_api/seeds |
Request Body Parameters
Examples
Update a single seed
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc=",
"seed": "c:\\testdata\\2500",
"type": "filesystem"
} |
Update multiple seeds
Code Block | ||
---|---|---|
| ||
[{
"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
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",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
"status": "N"
}],
"message": "optional response message"
} |
Status
Delete one or more seeds from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String, Path and Request Body Parameters
Examples
Delete a single seed
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Delete multiple seeds
Code Block | ||
---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Delete multiple seeds (alternative form)
Code Block | ||
---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Start, stop, pause and resume crawls of one or more seeds.
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire_api/seeds/crawl POST /aspire_api/seeds/crawl/:action POST /aspire_api/seeds/crawl/:action/:type |
Query String, Path and Request Body Objects
The action to perform:
Defaults to start if not specified
The type of crawl to start:
Defaults to incremental if not specified
Examples
Starts a crawl for a single seed
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Starts a crawl for multiple seeds
Code Block | ||
---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Starts a crawl for seeds (alternative form)
Code Block | ||
---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status