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 |
Pagination query string parameters
Sorting query string parameter
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 | ||||
---|---|---|---|---|
| ||||
{ "count": { "totalItems": 2 }, "connector": [ { "id": "948a9d99-5b71-4023-976e-14dcdc82f231", "artifact": "AAABcID5GBc=com.accenture.aspire:aspire-ldap-cache-source", "type": "filesystemldap", "description": "LDAP", "NetApp connector", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", .... }, "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e" }, { "id": "AAABcIueWUc="16e901a5-75c7-4969-90d2-70ad299916f3", "artifact": "com.accenture.aspire:aspire-filesystem-source", "type": "shareoint-onlinefilesystem", "description": "SharePoint Online", FS_Demo", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", .... }, "checksum": "0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62" } ] } |
: 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
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | 404 | The given connector id was not found
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create connectorsAdd connector(s)Add one or more connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Examples
ExampleAdd a single connector
Add multiple connectors
Response
See Response Body for details regrading 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Updateconnectorsconnector(s)Updates one or more connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path and Request Body Parameters
Body Parameters
Examples
x - at least one field must be present
Example - update more Update multiple connectors
Response
Status: 200, 404, 406
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given connector identifier was not found |
Status: 200, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deleteconnectorsconnector(s)Delete one or more connectors from Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters and Query String Parametersparameters
Examples Body Parameter
ExamplesDelete a single connector
Delete multiple connectors
Response
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 | ||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||
Status: 200, 404, 406
Get connectors typesLists all available connectors types
Query String Parameters | |||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | type | string | Optional | Filter results to return only the specified type
Filters: The connector filter definition here Response
|
: 200 |
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export connector(s)Export one or more connector from Aspire, this endpoint needs at least the OPERATOR role to be executed. Get specific connector typeReturns the type of a specific connector
Path Parameters and Query parameters
Body ParameterQuery String Parameters
ExamplesResponse
StatusResponse Response
| |||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||
Status: 200, 404, 406
Get connector type dxfReturns the dxf for a specific connector type | |||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description |
|
Query String Parameters
|
Response
|
: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
|