The connectors API provides functionality that allows a administrator to perform actions such as adding and configuring connectors
Table of Contents |
---|
Section | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all connectorsLists all the connectors configured in the Aspire
Pagination query string parameters
Response
| |||||||||||||||||||||
Response code | Description | Success |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single connectorGet information about a single connector configured in Aspire
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | |||||||||||||||||||
404 | The given connector id was not found |
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire
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 | |||||||||||||||||||||||||||||||||||||
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
Body Parameters
Example - update one connector
Example - update more connectors
Response
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors | |||||||||||||||||||||||||||||||||||||||||
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 connectors, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
Response
|
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple connectors, filteredDelete multiple connectors from Aspire, filtered by a specified criteria
Response
| ||||||||||||
Response code | Description | Success |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete connector(s)Delete one or more connectors from Aspire.
Path Parameters and Query parameters
Body Parameter
Examples
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors | |||||||||||||||||||||||||||||||||
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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Get connectors types (TODO)Lists all available connectors types
Response
| ||||||||||||
Response code | Description | Success |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get specific connector type (TODO)Returns the type of a specific connector
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | Success |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get connector type dxf (TODO)Returns the dxf for a specific connector type
Path Parameters
Response
| ||||||||||||||||||||
Response code | Description | |||||||||||||||||||
200 | Success | 404 | Not found - a given service identifier was not found