The connectors API provides functionality that allows a administrator to perform actions such as adding and configuring connectors

Table of Contents

Section

Get all connectors

Lists all the connectors configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors

Pagination query string parameters

Section

Get all connectors, filtered

Lists connectors configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/getAll

Pagination query string parameters

Common filter

Response

Code Block

language	js

{
  "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

Section

Get a single connector

Get information about a single connector configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the connector to return

Response

Code Block

language	js

{
  "connector": {
    "id": "AAABcID5GBc=",
    "type": "filesystem"
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  }
}

Status: 200, 404

Section

Add connector(s)

Add connectors to Aspire

Panel

borderColor	black
bgColor	#fafafb

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

Code Block

language	js

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

Code Block

language	js

{
  "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

Section

Update connector(s)

Updates connectors in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors/:id

PUT /aspire/_api/connectors

Note
The existing document will be replaced by the new one provided in the body

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
...	...	...	...

+ fields from "Add" section...

Example - update one connector

Code Block

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

Code Block

language	js

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem",
    .....
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "type": "sharepoint"
    ....
  }
}

Response

Code Block

language	js

{
  "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

Section

Update connectors, filtered

Update connectors configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/updateAll

Common filter

Update body parameter

Response

Code Block

language	js

{
  "message": "update result response message"
}

Status: 200, 406

Section

Delete multiple connectors, filtered

Delete multiple connectors from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/deleteAll

Common filter

Response

Code Block

language	js

{
  "message": "delete result response message"
}

Status: 200

Section

Delete connector(s)

Delete one or more connectors from Aspire.

Panel

borderColor	black
bgColor	#fafafb

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

Code Block

language	js

DELETE /aspire/_api/connectors/AAABcID5GBc

DELETE /aspire/_api/connectors?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connectors/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Section

Get connectors types (TODO)

Lists all available connectors types

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/type

Response

Code Block

language	js

{
  "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

Section

Get specific connector type (TODO)

Returns the type of a specific connector

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/:id/type

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the type to retrieve

Response

Code Block

language	js

{
  "type": [{
    "id": "filesystem",
    "description": "Filesytem Connector",
    "coordinates": "com.accenture.aspire:aspire-filesystem-source"
  }
  ]
}

Status: 200

Section

Get connector type dxf (TODO)

Returns the dxf for a specific connector type

Panel

borderColor	black
bgColor	#fafafb

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

Code Block

language	js

{
  "dxf": {...}
  "message": "optional response message"
}

Status: 200

Page tree

Versions Compared

Old Version 86

New Version 87

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connector(s)

Update connector(s)

Update connectors, filtered

Delete multiple connectors, filtered

Delete connector(s)

Get connectors types (TODO)

Get specific connector type (TODO)

Get connector type dxf (TODO)

Page tree

Page History

Versions Compared

Old Version 86

New Version 87

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connector(s)

Update connector(s)

Update connectors, filtered

Delete multiple connectors, filtered

Delete connector(s)

Get connectors types (TODO)

Get specific connector type (TODO)

Get connector type dxf (TODO)