The connectors API provides functionality that allows a administrator to perform actions such as adding and configuring connectors
Get all connectors
Lists all the connectors configured in the Aspire
GET /aspire/_api/connectors
TODO: pagination, sorting, expand - general description <here>
Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| from | integer | Optional | Indicates the initial page to be retrieved |
| size | integer | Optional | Specifies the size of results page |
| sortBy (NOT IMPLEMENTED YET) | string | Optional | Field by which results are sorted |
| sortMode (NOT IMPLEMENTED YET) | string | Optional | Sort mode
|
| $expand (NOT SUPPORTED) | string | Optional | List of fields to expand, * will expand everything |
Response
{
"connector": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "NetApp connector",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
},
{
"id": "AAABcIueWUc=",
"type": "sharepoint-online",
"description": "SharePoint Online",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}],
"from": 100, (NOT IMPLEMENTED YET)
"size": 10, (NOT IMPLEMENTED YET)
"totalItems": 10000 (NOT IMPLEMENTED YET)
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
Get all connectors, filtered
Lists connectors configured in the Aspire, filtered by a specified criteria
POST /aspire/_api/connectors/getAll
TODO: just everything from the above + general filter (ids, type, description)
Get a single connector
Get information about a single connector configured in Aspire
GET /aspire/_api/connectors/:id
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The id of the connector to return |
Query String Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| expand (NOT SUPPORTED) | string | Optional | List of fields to expand, * will expand everything |
Response
{
"connector": {
"id": "AAABcID5GBc=",
"type": "filesystem"
"description": "NetApp connector",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | The given connector id was not found |
Add connectors
Add connectors to Aspire
POST /aspire/_api/connectors
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Required | The type of this connector |
| description | string | Required | An optional description of the connector |
Example
POST /aspire/_api/connectors
[{
"type": "filesystem",
"description": "NetApp",
...
},
{
"type": "sharepoint",
"description": "SharePoint Online",
...
}]
Response
{
"connector": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "NetApp",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
},
{
"id": "BAABcID5GBc=",
"type": "sharepoint",
"description": "SharePoint Online",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { 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
| Response code | Description |
|---|---|
| 201 | Created |
| 406 | Not acceptable - there was an issue validating the input |
Update connectors
Updates connectors in Aspire.
PUT /aspire/_api/connectors
Body Parameters
| 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 |
Example
PUT /aspire/_api/connectors
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"description": "Net App",
"type": "filesystem"
},
"AAABcID5GBd=": {
"id": "AAABcID5GBd=",
"description": "Sharepoint online",
"type": "sharepoint"
}
}
Response
{
"connector": [{
"id": "AAABcID5GBc=",
"description": "Net App",
"type": "filesystem",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
},
{
"id": "AAABcID5GBd=",
"description": "Sharepoint online",
"type": "sharepoint",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { 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
| 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 |
Delete multiple connectors, filtered
Delete multiple connectors from Aspire, filtered by a specified criteria
POST /aspire/_api/connectors/deleteAll
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filter | JSON | Required | Filters retrieved connectors. Check the filter definition here |
Response
{
"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
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | Not found - a given credential identifier was not found |
| 406 | Not acceptable - there was an issue validating the input |
Delete single connector
Delete one or more connectors from Aspire.
DELETE /aspire/_api/connectors/:id
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier(s) of the connector(s) to delete |
Example
DELETE /aspire/_api/connectors/AAABcID5GBc=
Response
{
"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
| 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 |
Get connectors types
Lists all available connectors types
GET /aspire/_api/connectors/type
Response
{
"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
| Response code | Description |
|---|---|
| 200 | Success |
Get specific connector type
Returns the type of a specific connector
GET /aspire/_api/connectors/:id/type
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The identifier of the type to retrieve |
Response
{
"type": [{
"id": "filesystem",
"description": "Filesytem Connector",
"coordinates": "com.accenture.aspire:aspire-filesystem-source"
}
]
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
Get connector type dxf
Returns the dxf for a specific connector type
GET /aspire/_api/connectors/type/:typeId/dxf
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 |
Response
{
"dxf": {...}
"message": "optional response message"
}
Status
| Response code | Description |
|---|---|
| 200 | Success |
| 404 | Not found - a given service identifier was not found |
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Credentials filter:
"filter" : {
"ids" : ["ID1", "ID2", "ID3", ...],
"type" : "TYPE",
"description" : "DESCRIPTION"
}
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.
Overview
Content Tools
Copyright © 2024 Accenture
