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.
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
type | string | Optional | Filter returned connectors to only those with the given type |
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 | ||||
---|---|---|---|---|
| ||||
{ "connectorcount": [{ "idtotalItems": "AAABcID5GBc=",2 "type": "filesystem",}, "descriptionconnector": "NetApp connector", [ "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }, {{ "id": "948a9d99-5b71-4023-976e-14dcdc82f231", "id": "AAABcIueWUc=", "typeartifact": "shareoint-onlinecom.accenture.aspire:aspire-ldap-cache-source", "description": "SharePoint Online", "createdtype": 1596707252548"ldap", "updated "description": 1596707252548"LDAP", "properties": { This will be a dynamic JSON object } "enableFetcher": "true", }] } |
Status
Get information about a single connector configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "connector": { "enableFetchUrl": "true", "idinfoCacheSize": "AAABcID5GBc=100", "type": "filesystem", "description": "NetApp connector", "created": 1596707252548, .... "updated": 1596707252548, "properties": { This will be a dynamic JSON object } } } |
Status
Add one or more connectors to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connectors |
Request Body Parameters
Examples
Add a single connector
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors { }, "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e" }, { "id": "16e901a5-75c7-4969-90d2-70ad299916f3", "artifact": "com.accenture.aspire:aspire-filesystem-source", "type": "filesystem", "description": "NetApp" } |
Add multiple connectors
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors [{ "type": "filesystem", "description": "NetAppFS_Demo" }, { "typeproperties": "sharepoint", { "description": "SharePoint Online" }] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "id": "AAABcID5GBc=", "typeenableFetcher": "filesystemtrue", "description": "NetApp", "created": 1596707252548, "updatedenableFetchUrl": 1596707252548"true", "properties": { This will be a dynamic JSON object } }, { "idinfoCacheSize": "BAABcID5GBc=100", "type": "sharepoint", "description": "SharePoint Online", .... "created": 1596707252548, }, "updatedchecksum": 1596707252548, "properties0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62": { This will be a dynamic JSON object} } }] } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
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.
| ||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||
Update connectorsUpdates one or more connectors in Aspire.
Path and Request Body Parameters
Response string
| Optional | The type of the connector |
| ||||
{
"connector": {
|
Examples
Update a single connector
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors/AAABcID5GBc%3D { "id": "AAABcID5GBc="948a9d99-5b71-4023-976e-14dcdc82f231", "descriptionartifact": "NetAppcom.accenture.aspire:aspire-ldap-cache-source", "type": "filesystemldap" } |
Update multiple connectors
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors { "AAABcID5GBc=": { "id, "description": "AAABcID5GBc=LDAP", "description": "Net App", "typeproperties": "filesystem"{ }, "AAABcID5GBc=": { "idenableFetcher": "AAABcID5GBd=true", "description": "Sharepoint online", "typeenableFetchUrl": "sharepoint" } } |
Response
Code Block | ||
---|---|---|
| ||
{true", "connector": [{ "id": "AAABcID5GBc=", "descriptioninfoCacheSize": "Net App100", ............. "type": "filesystem" }, "created": 1596707252548, "updatedchecksum": 1596707252548, "properties2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e": { This will be a dynamic JSON object } }] } |
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 and Query String Parameters
Examples
Delete a single connector
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc= |
Delete multiple connectors
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors
{
"id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
} |
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
}
} |
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 | Not found - a given connector identifier was not found | ||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type |
Query String Parameters
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
Returns the type of a specific connector
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/:id/type |
Query String 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 |
Query String Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status