Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The connector The 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 connectors configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Query String Parameters | ||||||||
Name | Type | Required | Description | |||||
type | string | Optional | Filter returned connectors to only those with the given type | |||||
description | string | Optional | Filter returned connectors to only those whose description 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 | ||
---|---|---|
| ||
{ "connector": [{ "id": "AAABcID5GBc=", "type": "filesystem", "descriptionconnector": "NetApp connector", }, [ { "id": "AAABcIueWUc=", "typeid": "shareoint-online948a9d99-5b71-4023-976e-14dcdc82f231", "description": "SharePoint Online", }], "messageartifact": "optional response message" } |
Status
Get information about a single connector configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String and Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "connector": { "id": "AAABcID5GBc=", "connector": "c:\\testdata\\2500", "type": "filesystem", "description": "2,500 files", "status": "Scom.accenture.aspire:aspire-ldap-cache-source", "type": "ldap", "description": "LDAP", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "start": 1584550193011, "stop": 1584550267047 }, "message": "optional response message" } |
Status
"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
| ||||||||||||||||||||||
Section | ||||||||||||||||||||||
Add connector(s)Add one or more connectors to Aspire
Request Body Parameters | ||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||
connector | string | Required | The url/path indicating the content to crawl | |||||||||||||||||||
type | string | Required | The type of connector to use for this connector (may be omitted if connector is specified) | |||||||||||||||||||
connector | string | Required | The identifier of the connector configuration to use for this connector (may be omitted if type is specified) | |||||||||||||||||||
description | string | Optional | An optional description of the connector | |||||||||||||||||||
credential | string | Optional | An optional id of the credential to use for this connector | |||||||||||||||||||
policy | string | Optional | An optional list of the policy identifiers to use for this connector | |||||||||||||||||||
workflow | string | Optional | An optional list of the workflow identifiers to use for this connector |
Code Block | ||
---|---|---|
| ||
{
"connector": "c:\\testdata\\2500",
"type": "filesystem"
} |
Add multiple connectors
Code Block | ||
---|---|---|
| ||
[{
"connector": "c:\\testdata\\2500",
"type": "filesystem"
},
{
"connector": "c:\\testdata\\250000",
"connector": "connector_1",
"description": "250,000 files",
"credential": "cred_1",
"policy": "policy_1",
"workflow": ["workflow_1","workflow_99"]
}] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "id": "AAABcID5GBc=", "connector": "c:\\testdata\\2500", { "typeid": "filesystem948a9d99-5b71-4023-976e-14dcdc82f231", "statusartifact": "N" }, com.accenture.aspire:aspire-ldap-cache-source", { "idtype": "AAABcIueWUc=ldap", "typedescription": "filesystemLDAP", "connectorproperties": "c:\\testdata\\250000", { "connectorenableFetcher": "connector_1true", "description": "250,000 files", "credentialenableFetchUrl": "cred_1true", "policy": "policy_1", "workflowinfoCacheSize": ["workflow_1","workflow_99"] 100", ............. "status": "N" }], "message "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"optional response message" } |
Status
}
} |
Status: 200, 404
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AddUpdateconnector(s)Update one or more connectors 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 Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Examples Update a single connector
Update multiple connectors
Response
Status | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given connector identifier was not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
name of the artifact | |||
properties | object | Required | Connector properties |
Example
Code Block | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connectors
[
{
"type": "filesystem",
"description": "FS Demo Test 1",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
"deleteCheckAfterErrors": "NEVER",
.....
}
},
{
"type": "filesystem",
"description": "FS Demo Test 2",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
"deleteCheckAfterErrors": "NEVER",
.................
}
}
] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"connector": [
{
"id": "8e971436-b78a-4c6d-bafb-e16f1433c6f6",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo_Test_1",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
..........
},
"checksum": "c27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46"
},
{
"id": "9ad25f3b-ae34-4cff-85e1-6884e5b8f070",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo_Test_2",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
.............
},
"checksum": "19a1ce2e3bb658c4831bbc706a13393874822bf03e1bac31a4f197770410afbb"
}
]
} |
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:
| |||||||||||||
Section | |||||||||||||
Delete connector(s)Delete one or more connectors from Aspire.
Query String, Path and Request Body Parameters | |||||||||||||
Name | Type | Required | Description | ||||||||||
id | string | Required | The identifier(s) of the connector(s) to delete |
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Delete multiple connectors
Code Block | ||
---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Delete multiple connectors (alternative form)
Code Block | ||
---|---|---|
| ||
{
"id": ["AAABcID5GBc=", "AAABcIueWUc="]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status