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 parameters Expand query string parameters (not supported) 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 Sorting query string parameters Expand query string parameters (not supported) |
Section |
---|
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Expand query string parameters (not supported)
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
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors [ { "type": "filesystem", "description": "FS Demo", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher "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", ..... } }, { "typeinfoCacheSize": "filesystem100", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-filesystem-source", .... "properties": { "enableFetcher": "true" }, "enableFetchUrl "checksum": "true0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62", ....} }] } ] |
ResponseStatus: 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
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 | |||||||||||||||||||||||||||
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Update connectorsUpdates connectors in Aspire.
Body Path Parameters
Body Parameters
Example - update one connector
Example
Example - update more connectors
Response
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given connector identifier was not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | |||||||
---|---|---|---|---|---|---|---|
Update all connectors, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
|
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 connectors from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc= |
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
Lists all available connectors types
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type |
Response
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connector to update |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connector to update |
description | string | x | The description of the connector |
properties | object | x | Connector properties |
x - at least one field must be present
Example - update one connector
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe
{
"id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe",
"description": "NetApp - First- UPDATE",
"properties": {
"enableFetcher": "true",
.....
}
} |
Example - update more connectors
Code Block | ||||
---|---|---|---|---|
| ||||
PUT /aspire/_api/connectors
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"description": "Net App",
"properties": {
"enableFetcher": "true",
.....
}
},
"AAABcID5GBd=": {
"id": "AAABcID5GBd=",
"description": "Sharepoint online",
"properties": {
"enableFetcher": "true",
.....
}
}
} |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{"connector":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]} |
Status: 200, 404, 406
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connectors, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the ADMINISTRATOR role to be executed.
Filters: The connector filter definition here
Response
Status: 200, 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
Status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get specific connector typeReturns the type of a specific connector
Path Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the type to retrieve |
Code Block | ||||
---|---|---|---|---|
| ||||
{
"type": [{
|
Status
Returns the dxf for a specific connector type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type/:typeId/dxf |
Path Parameters
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector | ||||||||||||
Name | Type | Required | Description | |||||||||
typeId | string | Required | The identifier of the type of connector for which we are going to retrieve the dxf |
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Credentials filter:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "artifact" : "ARTIFACT" } | ||||
Note | ||||
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.} |