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 | ||||
from | integer | Optional | Retrieves the specified page of results | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted |
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 | ||||
---|---|---|---|---|
| ||||
{ "connectorcount": [{ "idtotalItems": "AAABcID5GBc=" 2 }, "typeconnector": {[ { "id": "filesystem948a9d99-5b71-4023-976e-14dcdc82f231", "nameartifact": "File System" com.accenture.aspire:aspire-ldap-cache-source", }, "descriptiontype": "NetApp connectorldap", "created "description": 1596707252548"LDAP", "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }, { "idenableFetcher": "AAABcIueWUc=true", "type": { "idenableFetchUrl": "sharepoint-onlinetrue", "name": "Sharepoint online" }, "descriptioninfoCacheSize": "SharePoint Online100", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }] .... }, "from": 100, "sizechecksum": 10, "totalItems": 10000, "message": "optional response message" } |
Status
Lists connectors configured in the Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ "id": "AAABcID5GBc= "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", "type": { "id": "filesystem", .... "name": "File System" }, "description": "NetApp connector", "created": 1596707252548, "updatedchecksum": 1596707252548, "properties0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62": { This will be a dynamic JSON object } }, { "id": "AAABcIueWUc=", "type": { ] } |
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
| ||||||||||||||||||||||
Response code | Description | 200 | Success
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. Get a single connectorGet information about a single connector configured in Aspire
Query String Body Parameters
Example
Status | |||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||
404 | The given connector id was not found | ||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||
Add multiple connectorsAdd multiple 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", "enableFetchUrl": "true", "infoCacheSize": "100", "deleteCheckAfterErrors": "NEVER", ..... } }, { "type": "filesystem", "description": "NetApp" }, { "type": "sharepoint", "description": "SharePoint Online" }] |
Response
Code Block | ||
---|---|---|
| ||
{ "connector": [{ FS Demo Test 2", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "idenableFetcher": "AAABcID5GBc=true", "typeenableFetchUrl": "filesystemtrue", "description "infoCacheSize": "NetApp100", "created": 1596707252548, "updateddeleteCheckAfterErrors": 1596707252548"NEVER", "properties": { This will be a dynamic JSON object } }, ................. } } ] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "idconnector": "BAABcID5GBc=", [ "type": "sharepoint", { "description": "SharePoint Online", "createdid": 1596707252548"8e971436-b78a-4c6d-bafb-e16f1433c6f6", "updated "artifact": 1596707252548, "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
Add a single connector to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connectors |
Body Parameters
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors
{
"type": "filesystem",
"description": "NetApp"
} |
Response
Code Block | ||
---|---|---|
| ||
{
"connector": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "NetApp",
"created": 1596707252548,
"updated": 1596707252548,
"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
Updates multiple connectors in Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Examples
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/connectors
{
"AAABcID5GBc=": {
"id": "AAABcID5GBc=",
"description": "Net App",
"type": "filesystem"
},
"AAABcID5GBd=": {
"id": "AAABcID5GBd=",
"description": "Sharepoint online",
"type": "sharepoint"
}
} |
Response
Code Block | ||
---|---|---|
| ||
{
"connector": [{
"id": "AAABcID5GBc=",
"description": "Net App",
"type": "filesystem",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
},
{
"id": "AAABcID5GBd=",
"description": "Sharepoint online",
"type": "sharepoint",
"created": 1596707252548,
"updated": 1596707252548,
"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
"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 | |||||||||||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||
Update single connectorUpdates a single connector in Aspire.
Query String Parameters
Path Parameters
Body Parameters
x - at least one field must be present Example
Response
Example - update more connectors
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||
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
},
"AAABcID5GBd=": {
"id": "AAABcID5GBd=",
"description": "Sharepoint online",
"properties": {
"enableFetcher": "true",
.....
}
}
} |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "messageconnector": "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
[{"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.
|
Delete one or more connectors from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
DELETE /
|
Query String 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
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. | ||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||
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 |
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 |
Query String Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"type": [{
"id": "filesystem",
"description": "Filesytem Connector",
"coordinates": "com.accenture.aspire:aspire-filesystem-source"
}
]
} |
Path Parameters and Query parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the connector(s) to delete |
Body Parameter
Name | Type | Required | Description |
---|---|---|---|
ids | string | Required | The identifier(s) of the connector(s) to delete |
Examples
Code Block | ||||
---|---|---|---|---|
| ||||
DELETE /aspire/_api/connectors/AAABcID5GBc
DELETE /aspire/_api/connectors?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/connectors/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple connectors, filteredDelete multiple connectors from Aspire, filtered by a specified criteria, this endpoint need the ADMINISTRATOR role to be executed.
Filters: The connector filter definition here Response
Status: 200 |
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 |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
| |||||||||||||
Response code | Description | ||||||||||||
200 | Success | ||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type/:typeId/dxf |
Query String 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" : ["id1ID1", "id2ID2", "id3ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "artifact" : "ARTIFACT" } | ||
Note | ||
When using delete endpoints, ids in the filter are mandatory.} |