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.
Pagination query string parameters Sorting query string parameters Expand query string parameters (not supported) Response
Response
Status | ||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||
200 | Success |
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 | |||||||
Name | Type | Required | Description | ||||
id | string | Required | The id of the connector to return | ||||
Name | Type | Required | Description | ||||
expand (NOT SUPPORTED) | string | Optional | List of fields to expand, * will expand everything |
Code Block | ||
---|---|---|
| ||
{ "connector": { "id": "AAABcID5GBc=", "infoCacheSize": "100", .... }, "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e" }, { "id": "16e901a5-75c7-4969-90d2-70ad299916f3", "artifact": "com.accenture.aspire:aspire-filesystem-source", "type": "filesystem", "description": "NetApp connectorFS_Demo", "created": 1596707252548, "updatedproperties": 1596707252548, "properties": { This will be a dynamic JSON object } } } |
Status
{
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
....
},
"checksum": "0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62"
}
]
} |
Status: 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
Add connectorsAdd connectors to Aspire
Body Parameters | |||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||
type | string | Required | The type of this connector | ||||||||||||||||||||||||||
description | string | Required | An optional description of the connector |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors [ { "type": "filesystem", "description": "FS Demo", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }, { "type": "filesystem", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-ldap-filesystemcache-source", "properties": { "enableFetchertype": "trueldap", "enableFetchUrldescription": "trueLDAP", .... "properties": { } } ] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "idenableFetcher": "AAABcID5GBc=true", "type "enableFetchUrl": "filesystemtrue", "description": "FS Demo", "artifactinfoCacheSize": "com.accenture.aspire:aspire-filesystem-source", "100", ............. "properties": { }, "enableFetcherchecksum": "true2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e", ..... } }, { "id": "BAABcID5GBc=", "type": "filesystem", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true} } |
Status: 200, 404
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
Example
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 | |||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||
Update connectorsUpdates connectors in Aspire.
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 |
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "description": "Net App", "FS Demo Test 1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", "deleteCheckAfterErrors": "NEVER", ..... } }, { "type": "filesystem", }, "AAABcID5GBd=": { "iddescription": "AAABcID5GBd=FS Demo Test 2", "descriptionartifact": "Sharepoint onlinecom.accenture.aspire:aspire-filesystem-source", "type": "sharepoint" } } |
Response
Code Block | ||
---|---|---|
| ||
{ "connectorproperties": [{ "id": "AAABcID5GBc=", "descriptionenableFetcher": "Net Apptrue", "type": "filesystem", "createdenableFetchUrl": 1596707252548"true", "updated": 1596707252548, "properties": { This will be a dynamic JSON object }"infoCacheSize": "100", }, { "iddeleteCheckAfterErrors": "AAABcID5GBd=NEVER", ................. "description": "Sharepoint online",} "type": "sharepoint",} ] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "createdconnector": 1596707252548, [ { "updatedid": 1596707252548"8e971436-b78a-4c6d-bafb-e16f1433c6f6", "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
Delete multiple connectors from Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"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
Delete one or more connectors from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Example
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc= |
Response
Code Block | ||
---|---|---|
| ||
{
"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
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo_Test_1",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
..........
},
"checksum": "c27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46"
},
{
"id": "9ad25f3b-ae34-4cff-85e1-6884e5b8f070",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo_Test_2",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
.............
},
"checksum": "19a1ce2e3bb658c4831bbc706a13393874822bf03e1bac31a4f197770410afbb"
}
]
} |
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 201, 406
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update connector(s)Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
x - at least one field must be present
Example - update more connectors
Response
Status: 200, 404, 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 parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
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: 200, 404, 406
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type |
Response
Code Block | ||
---|---|---|
| ||
{
"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
Returns the type of a specific connector
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/:id/type |
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"type": [{
"id": "filesystem",
|
Status
Returns the dxf for a specific connector type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type/:typeId/dxf |
Path Parameters
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector | ||||||||||||
Name | Type | Required | Description | |||||||||
typeId | string | Required | The identifier of the type of connector for which we are going to retrieve the dxf |
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Credentials filter:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "artifact" : "ARTIFACT" } | ||||
Note | ||||
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.} |