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 |
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": [{ "id": "AAABcID5GBc=", "typetotalItems": {2 }, "idconnector": "filesystem",[ "name": "File System" { }, "descriptionid": "NetApp connector948a9d99-5b71-4023-976e-14dcdc82f231", "created": 1596707252548, "updatedartifact": 1596707252548, "properties": { This will be a dynamic JSON object } }, { "com.accenture.aspire:aspire-ldap-cache-source", "idtype": "AAABcIueWUc=ldap", "type": { "iddescription": "sharepoint-onlineLDAP", "name": "Sharepoint online" },"properties": { "description": "SharePoint Online", "created": 1596707252548, "updatedenableFetcher": 1596707252548"true", "properties": { This will be a dynamic JSON object } }], "fromenableFetchUrl": 100"true", "size "infoCacheSize": 10"100", "totalItems": 10000, "message": "optional response message" } |
Status
Get information about a single connector configured in Aspire
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "connector": { "id": "AAABcID5GBc=", "type": { .... }, "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e" }, { "id": "16e901a5-75c7-4969-90d2-70ad299916f3", "artifact": "com.accenture.aspire:aspire-filesystem-source", "idtype": "filesystem", "name": "File System" }, "description": "NetApp connectorFS_Demo", "created": 1596707252548, "updatedproperties": 1596707252548, "properties": { This will be a dynamic JSON object } } } |
Status
Add one or more connectors to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/connectors |
Request Body Parameters
Examples
Add a single connector
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors
{
"type": "filesystem",
"description": "NetApp"
} |
Add multiple connectors
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/connectors
[{
"type": "filesystem",
"description": "NetApp"
},
{
"type": "sharepoint",
"description": "SharePoint Online"
}] |
Response
Code Block | ||
---|---|---|
| ||
{
"connector": [{
"id": "AAABcID5GBc=",
"type": "filesystem",
"description": "NetApp",
"created": 1596707252548,
"updated": 1596707252548,
"properties": { This will be a dynamic JSON object }
},
{
"id": "BAABcID5GBc=",
"type": "sharepoint",
"description": "SharePoint Online",
"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
{
"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
Status: 200, 404 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add connector(s)Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed | ||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||
Update connectorsUpdates one or more connectors in Aspire.
Path and Request Body Parameters
Examples
ExampleUpdate a single connector
Update 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 |
},
{
"type": "filesystem",
"description": "FS Demo Test 2",
"artifact": "com.accenture.aspire:aspire-filesystem-source",
"properties": {
"enableFetcher": "true",
"enableFetchUrl": "true",
"infoCacheSize": "100",
"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 |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Connector filter:
| |||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Query String Parameters
Examples
Delete a single connector
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors/AAABcID5GBc= |
Delete multiple connectors
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/connectors?id=AAABcID5GBc=&id=AAABcIueWUc=
|
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
Lists all available connectors types
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/connectors/type |
Query String Parameters
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 |
Query String Parameters
Response
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 |
Query String Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"dxf": {...}
"message": "optional response message"
} |
Status