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 Sorting query string parameters Expand query string parameters (not supported) Response
Status
|
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 | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single connectorGet information about a single connector configured in Aspire
Path Parameters
Expand query string parameters (not supported) Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connectorsAdd connectors to Aspire
Body Parameters
Example
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
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 regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||
---|---|---|---|---|---|---|---|
Update connectors, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
|
Section | |||||||
---|---|---|---|---|---|---|---|
Delete multiple connectors, filteredDelete multiple connectors from Aspire, filtered by a specified criteria
Body Parameters | |||||||
Name | Type | Required | Description | filter | JSON | Required | Filters retrieved connectors. Check the filter definition here
Code Block | ||
---|---|---|
| ||
{ "message": "optional response message" } |
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
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deletesingleconnector(s)Delete one or more connectors from Aspire.
Path Parameters and Query parameters
Body Parameter
Example
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get connectors typesLists all available connectors types
Response
Status
|
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get specific connector typeReturns the type of a specific connector
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get connector type dxfReturns the dxf for a specific connector type
Path Parameters
Response
Status
|
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
|