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

Sorting query string parameters

Expand query string parameters (not supported)

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

Response code	Description
200	Success

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

Sorting query string parameters

Expand query string parameters (not supported)

Common filter

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

Query String Parameters

Name	Type	Required	Description
expand (NOT SUPPORTED)	string	Optional	List of fields to expand, * will expand everything

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

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

Section

Add connectors

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

Example

Code Block

language	js

POST /aspire/_api/connectors
[
  {
    "type": "filesystem",
    "description": "FS Demo",
    "artifact": "NetApp"com.accenture.aspire:aspire-filesystem-source",
    "properties": {
      "enableFetcher": "true",
      .....
    }
  },
  {
    "type": "sharepointfilesystem",
    "description": "FS Demo1",
    "artifact": "com.accenture.aspire:aspire-filesystem-source",
    "properties": {
      "enableFetcher": "true",
 "SharePoint Online     "enableFetchUrl": "true",
      ....
    }
  }
]

Response

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetAppFS Demo",
    "createdartifact": 1596707252548"com.accenture.aspire:aspire-filesystem-source",
    "updatedproperties": 1596707252548,
	"properties{
      "enableFetcher": { This will be a dynamic JSON object } "true",
      .....
    }
  },
  {
    "id": "BAABcID5GBc=",
    "type": "sharepointfilesystem",
    "description": "SharePointFS OnlineDemo1",
    "createdartifact": 1596707252548"com.accenture.aspire:aspire-filesystem-source",
    "updatedproperties": 1596707252548,
	"properties{
      "enableFetcher": { This will be a dynamic JSON object } "true",
      .....
    }
  }]
}

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

Section

Update connectors

Updates connectors in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors

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

Example

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",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   },
   {
    "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "type": "sharepoint",
    "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

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

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters retrieved connectors. Check the filter definition here

Response

Code Block

language	js

{
  "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 credential identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete single connector

Delete one or more connectors from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/connectors/:id

Path Parameters

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

Example

Code Block

language	js

DELETE /aspire/_api/connectors/AAABcID5GBc=

Response

Code Block

language	js

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

Section

Get connectors types

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

Response code	Description
200	Success

Section

Get specific connector type

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

Response code	Description
200	Success

Section

Get connector type dxf

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

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

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Credentials filter:

Code Block

language	js

  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION"
  }

Note
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.

Page tree

Versions Compared

Old Version 57

New Version 58

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connectors

Update connectors

Delete multiple connectors, filtered

Delete single connector

Get connectors types

Get specific connector type

Get connector type dxf

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 57

New Version 58

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connectors

Update connectors

Delete multiple connectors, filtered

Delete single connector

Get connectors types

Get specific connector type

Get connector type dxf

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor