The connectors API provides functionality that allows a administrator or operator to perform actions such as adding and configuring connectors.
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all connectorsLists all the connectors configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters Sorting query string parametersparameter Response
Response
Status | ||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||
200 | Success |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all connectors, filteredLists connectors configured in the Aspire, filtered by a specified criteria
Pagination query string parameters |
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 | ||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"connector": {
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "NetApp connector",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}
} |
Status
Add connectors to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connectors |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
typeid | string | Required | The type id of this the connector to return |
Response
descriptionCode Block |
---|
|
|
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors [ { "typeconnector": "filesystem", { "descriptionid": "FS Demo948a9d99-5b71-4023-976e-14dcdc82f231", "artifact": "com.accenture.aspire:aspire-ldap-filesystemcache-source", "propertiestype": { "ldap", "enableFetcherdescription": "trueLDAP", ..... "properties": { } }, { "typeenableFetcher": "filesystemtrue", "description": "FS Demo1", "artifactenableFetchUrl": "com.accenture.aspire:aspire-filesystem-sourcetrue", "properties": { "enableFetcherinfoCacheSize": "true100", ............. "enableFetchUrl": "true" }, .... } } ] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "id "checksum": "AAABcID5GBc=2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e", "type": "filesystem", "description": "FS Demo", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }, { "} } |
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
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status | ||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||
Update connector(s)Updates connectors in Aspire.
Path Parameters | ||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||
id | string | Required | The identifier of the connector to update | |||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||
id | string | Required | The identifier of the connector to update | |||||||||||||||||||||||||||||||
type | string | Optional | The type of the connector | |||||||||||||||||||||||||||||||
description | string | Optional | An optional description of the connector | ... | other connector fields |
Code Block |
---|
PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe { "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe", "type": "filesystem "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", "description": "NetApp - First- UPDATE", "artifactdeleteCheckAfterErrors": "blaNEVER", ................. } } ] |
ResponseExample - update more connectors
Code Block | ||||
---|---|---|---|---|
| ||||
PUT /aspire/_api/connectors { "AAABcID5GBc=connector": {[ { "id": "AAABcID5GBc=8e971436-b78a-4c6d-bafb-e16f1433c6f6", "descriptionartifact": "Net Appcom.accenture.aspire:aspire-filesystem-source", "type": "filesystem", ..... }, "AAABcID5GBd=": { "iddescription": "AAABcID5GBd=FS_Demo_Test_1", "description": "Sharepoint online", "typeproperties": "sharepoint" { .... } } |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "idenableFetcher": "AAABcID5GBc=true", "description": "Net App", "typeenableFetchUrl": "filesystemtrue", .... }, { "idinfoCacheSize": "AAABcID5GBd=100", .......... "description": "Sharepoint online"}, "typechecksum": "sharepointc27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46", ...... }] } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
Section | |||||||
---|---|---|---|---|---|---|---|
Update connectors, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
|
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 |
Panel | ||||
---|---|---|---|---|
| ||||
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Delete one or more connectors from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters and Query parameters
Body Parameter
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc=
POST /aspire/_api/connectors
{
"ids":["id1","id2"]
|
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
Filters: The connection filter definition here Response
|
Status
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
| |||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/:id/type |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"type": [{
"id": "filesystem",
"description": "Filesytem Connector",
"coordinates": "com.accenture.aspire:aspire-filesystem-source"
}
]
} |
Status
Returns the dxf for a specific connector type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type/:typeId/dxf |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status