The connectors API provides functionality that allows a administrator to perform actions such as adding and configuring connectors
Lists all the connectors configured in the Aspire
GET /aspire/_api/connectors
Pagination query string parameters
Lists connectors configured in the Aspire, filtered by a specified criteria
Response
{ "connector": [{ "id": "AAABcID5GBc=", "type": "filesystem", "description": "NetApp connector", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }, { "id": "AAABcIueWUc=", "type": "sharepoint-online", "description": "SharePoint Online", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } }], "from": 100, "size": 10, "totalItems": 10000 }
Status: 200
Get information about a single connector configured in Aspire
GET /aspire/_api/connectors/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The id of the connector to return |
Response
{ "connector": { "id": "AAABcID5GBc=", "type": "filesystem" "description": "NetApp connector", "created": 1596707252548, "updated": 1596707252548, "properties": { This will be a dynamic JSON object } } }
Status: 200, 404
Add connectors to Aspire
POST /aspire/_api/connectors
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
type | string | Required | The type of this connector |
description | string | Required | An optional 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", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }, { "type": "filesystem", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", "enableFetchUrl": "true", .... } } ]
Response
{ "connector": [{ "id": "AAABcID5GBc=", "type": "filesystem", "description": "FS Demo", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }, { "id": "BAABcID5GBc=", "type": "filesystem", "description": "FS Demo1", "artifact": "com.accenture.aspire:aspire-filesystem-source", "properties": { "enableFetcher": "true", ..... } }] }
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.
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 |
other parameters mentioned in the above "Add" section |
Example - update one connector
PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe { "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe", "type": "filesystem", "description": "NetApp - First- UPDATE", "artifact": "bla", ..... }
Example - update more connectors
PUT /aspire/_api/connectors { "AAABcID5GBc=": { "id": "AAABcID5GBc=", "description": "Net App", "type": "filesystem", ..... }, "AAABcID5GBd=": { "id": "AAABcID5GBd=", "description": "Sharepoint online", "type": "sharepoint" .... } }
Response
{ "connector": [{ "id": "AAABcID5GBc=", "description": "Net App", "type": "filesystem", .... }, { "id": "AAABcID5GBd=", "description": "Sharepoint online", "type": "sharepoint", ...... }] }
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors
Status: 200, 404, 406
Update connectors configured in the Aspire, filtered by a specified criteria
POST /aspire/_api/connectors/updateAll
Response
{ "message": "update result response message" }
Delete multiple connectors from Aspire, filtered by a specified criteria
POST /aspire/_api/connectors/deleteAll
Response
{ "message": "delete result response message" }
Status: 200
Delete one or more connectors from Aspire.
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" }
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
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