Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The connector The connectors API provides functionality that allows a administrator or operator to perform actions such as adding and configuring connectors.
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | |||||||
---|---|---|---|---|---|---|---|
List 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 |
connectors |
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": "AAABcID5GBc=948a9d99-5b71-4023-976e-14dcdc82f231", "artifact": "com.accenture.aspire:aspire-ldap-cache-source", "type": "filesystemldap", "description": "LDAP", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize"NetApp: connector"100", .... }, "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e" }, { "id": "AAABcIueWUc=", "16e901a5-75c7-4969-90d2-70ad299916f3", "artifact": "com.accenture.aspire:aspire-filesystem-source", "type": "shareoint-onlinefilesystem", "description": "FS_Demo", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize"SharePoint: Online"100", .... }], "messagechecksum": "optional response message""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.
Query String and Path Parameters
Response
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | 404 | The given connector id was not found
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add 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
Status | |||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | 406 | Not acceptable - there was an issue validating the input
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connector(s)Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.Update a connector in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null
Path Request Body Parameters
Body Parameters
Examples
x - at least one field must be present
ResponseExample - update more connectors
StatusResponse Response
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given connector identifier was not found |
| |
{"connector":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]} |
Status: 200, 404, 406
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connectors, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the ADMINISTRATOR role to be executed.
Filters: The connector filter definition here
Response
Status: 200, 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 parametersQuery String, Path and Request Body Parameters
Examples Delete a single connector Body Parameter
Examples
Delete multiple connectorsResponse
Status: 200, 404, 406
Delete multiple connectors (alternative form)
|
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 | ||||||||||||||||||||||||||||||||||||||||||||||||
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
"id": "<connector_id>",
"artifact": "com.accenture.aspire:aspire-rest-source",
"type": "rest-api",
"description": "RestConnector",
"properties": {
"debug": false,
"wDebug": false,
...
},
"checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
},
...
]
}
}
} |
Status: 200, 404, 406
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export multiple connectors, filteredExport multiple connectors from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.
Filters: The connection filter definition here Response
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
|