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 parameter
Response
Status: 200
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 |
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: 200, 404
Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
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": "true", ..... } }, { "type": "filesystem", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", "enableFetchUrlartifact": "truecom.accenture.aspire:aspire-ldap-cache-source", .... } } ] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "type": "ldap", "iddescription": "AAABcID5GBc=LDAP", "type "properties": "filesystem",{ "description": "FS Demo", "artifactenableFetcher": "com.accenture.aspire:aspire-filesystem-sourcetrue", "properties": { "enableFetcherenableFetchUrl": "true", ..... } }, { "infoCacheSize": "100", ............. "id": "BAABcID5GBc=" }, "type": "filesystem", "descriptionchecksum": "FS Demo12f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }] } |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
}
} |
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
| |||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||
Update connector(s)Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
Example string
| Required | The identifier of the connector to update | |||||||||||||||||||||||||
... | ... | ... | ... |
| ||||
POST |
+ fields from "Add" section...
Example - update one connector
Code Block |
---|
PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe { [ { "idtype": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fefilesystem", "description": "NetAppFS -Demo First-Test UPDATE1", "properties": { "enableFetcherartifact": "true", com.accenture.aspire:aspire-filesystem-source", ..... "properties": { } } |
Example - update more connectors
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors { "AAABcID5GBc=": { "idenableFetcher": "AAABcID5GBc=true", "descriptionenableFetchUrl": "Net Apptrue", "properties": { "enableFetcherinfoCacheSize": "true100", "deleteCheckAfterErrors": "NEVER", ..... } }, "AAABcID5GBd=": { "id "type": "AAABcID5GBd=filesystem", "description": "FS Demo Test 2", "artifact"Sharepoint online: "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } } } |
Response
Code Block | ||
---|---|---|
| ||
{"response"enableFetchUrl":{ "updatedtrue":true,"id":"AAABcID5GBc="}} {"response":{"connector":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}} |
Status: 200, 404, 406
Update connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "update result response message"
} |
Status: 200, 406
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple connectors, filteredDelete multiple connectors from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Response
Status: 200 |
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 | ||||
---|---|---|---|---|
| ||||
|
Path Parameters and Query parameters
Body Parameter
Examples
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc
DELETE /aspire/_api/connectors?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/connectors/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Lists all available connectors types
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type |
Response
Code Block | ||
---|---|---|
| ||
{
"type": [{
"id": "filesystem",
"description": "Filesytem Connector",
"coordinates": "com.accenture.aspire:aspire-filesystem-source"
},
{
"id": "sharepoint-online",
"description": "SharePoint Online Connector",
"coordinates": "com.accenture.aspire:aspire-sharepoint-online-source"
},
...
]
} |
Status: 200
Returns the type of a specific connector
Panel | ||||
---|---|---|---|---|
| ||||
GET
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the type to retrieveconnector 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
Response
|
Section |
---|
ImportThe import usage can be found here |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
Get connector type dxf (TODO)Returns the dxf for a specific connector type
Path Parameters | ||||||||||||||||||||
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"
} |