The connectors API provides functionality that allows a administrator or operator to perform actions such as adding and configuring connectors.
Lists all the connectors configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
GET /aspire/_api/connectors
Pagination query string parameters
Lists connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
POST /aspire/_api/connectors/getAll
Response
{ "count": { "totalItems": 2 }, "connector": [ { "id": "948a9d99-5b71-4023-976e-14dcdc82f231", "artifact": "com.accenture.aspire:aspire-ldap-cache-source", "type": "ldap", "description": "LDAP", "properties": { "enableFetcher": "true", "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
Get information about a single connector configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.
GET /aspire/_api/connectors/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the connector to return |
Response
{ "connector": { "id": "948a9d99-5b71-4023-976e-14dcdc82f231", "artifact": "com.accenture.aspire:aspire-ldap-cache-source", "type": "ldap", "description": "LDAP", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", ............. }, "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e" } }
Status: 200, 404
Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
POST /aspire/_api/connectors
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of this connector |
description | string | Required | The description of the connector |
artifact | string | Required | The name of the artifact |
properties | object | Required | Connector properties |
Example
POST /aspire/_api/connectors [ { "type": "filesystem", "description": "FS Demo Test 1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", "deleteCheckAfterErrors": "NEVER", ..... } }, { "type": "filesystem", "description": "FS Demo Test 2", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", "infoCacheSize": "100", "deleteCheckAfterErrors": "NEVER", ................. } } ]
Response
{ "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
Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.
PUT /aspire/_api/connectors/:id
PUT /aspire/_api/connectors
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connector to update |
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the connector to update |
description | string | x | The description of the connector |
properties | object | x | Connector properties |
x - at least one field must be present
Example - update one connector
PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe { "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe", "description": "NetApp - First- UPDATE", "properties": { "enableFetcher": "true", ..... } }
Example - update more connectors
PUT /aspire/_api/connectors { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "description": "Net App", "properties": { "enableFetcher": "true", ..... } }, "AAABcID5GBd=": { "id": "AAABcID5GBd=", "description": "Sharepoint online", "properties": { "enableFetcher": "true", ..... } } }
Response
{"response":{"updated":true,"id":"AAABcID5GBc="}} {"response":{"connector":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}}
Status: 200, 404, 406
Update connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.
Delete multiple connectors from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Delete one or more connectors from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
DELETE /aspire/_api/connectors/:id
DELETE /aspire/_api/connectors
POST /aspire/_api/connectors/delete
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
DELETE /aspire/_api/connectors/AAABcID5GBc DELETE /aspire/_api/connectors?id=AAABcID5GBc&id=AAABcID5GBd POST /aspire/_api/connectors/delete { "ids":["AAABcID5GBc","AAABcID5GBd"] }
Response
{ "message": "delete result response message" }
Status: 200, 404, 406
Lists all available connectors types
GET /aspire/_api/connectors/type
Response
{ "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: 200
Returns the type of a specific connector
GET /aspire/_api/connectors/:id/type
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the type to retrieve |
Response
{ "type": [{ "id": "filesystem", "description": "Filesytem Connector", "coordinates": "com.accenture.aspire:aspire-filesystem-source" } ] }
Status: 200
Returns the dxf for a specific connector type
GET /aspire/_api/connectors/type/:typeId/dxf
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
typeId | string | Required | The identifier of the type of connector for which we are going to retrieve the dxf |
Response
{ "dxf": {...} "message": "optional response message" }
Status: 200
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Seed filter:
"filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "DESCRIPTION", "artifact" : "ARTIFACT" }