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 TODO: pagination, sorting, expand - general description <here> Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Indicates the initial page to be retrieved | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy (NOT IMPLEMENTED YET) | string | Optional | Field by which results are sorted | ||||
sortMode (NOT IMPLEMENTED YET) | string | Optional | Sort mode
| ||||
$expand (NOT SUPPORTED) | string | Optional | List of fields to expand, * will expand everything |
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
} |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "id": "AAABcID5GBc=", "type": "filesystem", "descriptionconnector": "NetApp connector",[ "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }, { { "id": "AAABcIueWUc=948a9d99-5b71-4023-976e-14dcdc82f231", "typeartifact": "sharepoint-onlinecom.accenture.aspire:aspire-ldap-cache-source", "description "type": "SharePoint Onlineldap", "created": 1596707252548, "updateddescription": 1596707252548"LDAP", "properties": { This will be a dynamic JSON object } }], "fromenableFetcher": 100"true", (NOT IMPLEMENTED YET) "size": 10, (NOT IMPLEMENTED YET) "totalItems": 10000 (NOT IMPLEMENTED YET) } |
Status
Lists connectors configured in the Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
TODO: just everything from the above + general filter (ids, type, description)
Get information about a single connector configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
"enableFetchUrl": "true",
"infoCacheSize": "100",
....
},
"checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
},
{
"id": "16e901a5-75c7-4969-90d2-70ad299916f3",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"type": "filesystem",
"description": "FS_Demo",
"properties": {
"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. | |||||||||||||||||||||||||||||||
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=",
"type": "filesystem"
"description": "NetApp connector",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
}
} |
Status
Add connectors to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST
|
Body Path Parameters
Name | Type | Required | Description | ||||
---|---|---|---|---|---|---|---|
typeid | string | Required | The type of this connector | description | string | Required | An optional description ofid of the connector to return |
ExampleResponse
Code Block | ||||
---|---|---|---|---|
| ||||
{ "connector": { "id": "948a9d99-5b71-4023-976e-14dcdc82f231POST /aspire/_api/connectors [{ "type": "filesystem", "description": "NetApp", ... }, { "type": "sharepoint", "descriptionartifact": "SharePoint Onlinecom.accenture.aspire:aspire-ldap-cache-source", ... }] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "idtype": "AAABcID5GBc=ldap", "type": "filesystem", "description": "NetAppLDAP", "createdproperties": 1596707252548,{ "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }, { "enableFetcher": "true", "idenableFetchUrl": "BAABcID5GBc=true", "type": "sharepoint", "descriptioninfoCacheSize": "SharePoint Online100", ............. "created": 1596707252548 }, "updatedchecksum": 1596707252548, "properties2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e": { 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
}
} |
Status: 200, 404
Section | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Update connectorsUpdates connectors in 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 | |||||||||||||||||||||||||||||||||||||||||||||
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 |
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
"deleteCheckAfterErrors": "NEVER",
.................
}
}
] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"connector": [
{
"id": "8e971436-b78a-4c6d-bafb-e16f1433c6f6",
"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 | |||||||||||||||||||||||||||||||||||||||||||||
Get connectors typesLists all available connectors types
Status | |||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/:id/type |
Path Parameters
Status: 200 |
Section |
---|
ImportThe import usage can be found here |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector | ||||||||||||
Name | Type | Required | Description | |||||||||
id | string | Required | The identifier of the type to retrieve |
Code Block | ||
---|---|---|
| ||
{
"type": [{
"id": "filesystem",
"description": "Filesytem Connector",
"coordinates": "com.accenture.aspire:aspire-filesystem-source"
}
]
} |
Status
Returns the dxf for a specific connector type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type/:typeId/dxf |
Path Parameters
Response
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" : } | ||||
Note | ||||
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified."ARTIFACT"
}
} |