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

Get all connectors

Lists all the connectors configured in the Aspire

GET /aspire/_api/connectors

Query String Parameters

Name	Type	Required	Description
type	string	Optional	Filter returned connectors to only those with the given type
description	string	Optional	Filter returned connectors to only those whose description matches the given expression

Response

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": {
      "id": "filesystem",
      "name": "File System"
    },
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  },
  {
    "id": "AAABcIueWUc=",
    "type": {
      "id": "sharepoint-online",
      "name": "Sharepoint online"
    },
    "description": "SharePoint Online",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
  }],
  "from": 100,
  "size": 10,
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Get a single connector

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": {
      "id": "filesystem",
      "name": "File System"
    },
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  }
}

Status

Response code	Description
200	Success
404	The given connector id was not found

Add connectors

Add one or more connectors to Aspire

POST /aspire/_api/connectors

Request Body Parameters

Name	Type	Required	Description
type	string	Required	The type of this connector
description	string	Required	An optional description of the connector

Examples

Add a single connector

POST /aspire/_api/connectors
{
  "type": "filesystem",
  "description": "NetApp"
}

Add multiple connectors

POST /aspire/_api/connectors
[{
  "type": "filesystem",
  "description": "NetApp"
},
{
  "type": "sharepoint",
  "description": "SharePoint Online"
}]

Response

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

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Update connectors

Updates one or more connectors in Aspire.

PUT /aspire/_api/connectors/:id

PUT /aspire/_api/connectors

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connector to update
type	string	Optional	The type of the connector
description	string	Optional	An optional description of the connector

Examples

Update a single connector

PUT /aspire/_api/connectors/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "description": "NetApp",
  "type": "filesystem"
}

Update multiple connectors

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

Response

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem",
    "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

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

Delete connectors

Delete one or more connectors from Aspire.

DELETE /aspire/_api/connectors/:id

DELETE /aspire/_api/connectors

Path and Query String Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connector(s) to delete

Examples

Delete a single connector

DELETE /aspire/_api/connectors/AAABcID5GBc=

Delete multiple connectors

DELETE /aspire/_api/connectors
{
  "id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
}

Response

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

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

Get connectors types

Lists all available connectors types

GET /aspire/_api/connectors/type

Query String Parameters

Name	Type	Required	Description
type	string	Optional	Filter results to return only the specified 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

Response code	Description
200	Success

Get specific connector type

Returns the type of a specific connector

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

Query String Parameters

Name	Type	Required	Description

Response

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

Status

Response code	Description
200	Success

Get connector type dxf

Returns the dxf for a specific connector type

GET /aspire/_api/connectors/type/:typeId/dxf

Query String Parameters

Name	Type	Required	Description

Response

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

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Page tree

Get all connectors

Get a single connector

Add connectors

Update connectors

Delete connectors

Get connectors types

Get specific connector type

Get connector type dxf

Contact Us: [email protected]

Page tree

Connectors API

Get all connectors

Get a single connector

Add connectors

Update connectors

Delete connectors

Get connectors types

Get specific connector type

Get connector type dxf

Contact Us: [email protected]