Versions Compared

Old Version 32

changes.mady.by.user Petr Podsednik

Saved on

compared with

New Version 33

changes.mady.by.user Ricardo Fonseca

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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
borderColorblack
bgColor#fafafb
GET /aspire/_api/connectors


Query String Parameters

NameTypeRequiredDescription
fromintegerOptionalRetrieves the specified page of results
sizeintegerOptionalSpecifies the size of results page
sortBystringOptionalField by which results are sorted
sortModestringOptional"asc" for ascending sort, "desc" for descending sort


Response

Code Block
languagejs
{
  "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 codeDescription
200Success



Section

Get all connectors, filtered

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

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/connectors/getAll


Query String Parameters

NameTypeRequiredDescription
fromintegerOptionalRetrieves the specified page of results
sizeintegerOptionalSpecifies the size of results page
sortBystringOptionalField by which results are sorted
sortModestringOptional"asc" for ascending sort, "desc" for descending sort


Body Parameters

NameTypeRequiredDescription
FilterJSONRequiredFilters retrieved credentials. Check the filter definition here
typestringOptionalFilter returned connectors to only those with the given type
descriptionstringOptionalFilter returned connectors to only those whose description matches the given expression


Response

Code Block
languagejs
{
  "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 codeDescription
200Success



Section

Get a single connector

Get information about a single connector configured in Aspire

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/connectors/:id


Path Query String Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the connector to return


Response

Code Block
languagejs
{
  "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 codeDescription
200Success
404The given connector id was not found



Section

Add multiple connectors

Add one or more multiple connectors to Aspire

Panel
borderColorblack
bgColor#fafafb
POST /aspire/_api/connectors


Request Body Parameters

NameTypeRequiredDescription
typestringRequiredThe type of this connector
descriptionstringRequiredAn optional description of the connector


ExamplesExample

Add a single connector

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

Add multiple connectors

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


Response

Code Block
languagejs
{
  "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 codeDescription
201Created
406Not acceptable - there was an issue validating the input



Section

Add single connector

Add a single connector to Aspire

Update connectors

Updates one or more connectors in Aspire.

Panel
borderColorblack
bgColor#fafafb
PUT POST /aspire/_api/connectors


Body Parameters

NameTypeRequiredDescription
typestringRequiredThe type of this connector
descriptionstringRequiredAn optional description of the connector


Example

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


Response

Code Block
languagejs
{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp",
    "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 codeDescription
201Created
406Not acceptable - there was an issue validating the input



Section

Update multiple connectors

Updates multiple connectors in Aspire.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/connectors


Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update
typestringOptional
The type of the connector
descriptionstringOptionalAn optional description of the connector


Examples

Update a single connector

Code Block
languagejs
PUT /aspire/_api/connectors/AAABcID5GBc%3D
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "NetAppNet App",
    "type": "filesystem"
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "type": "sharepoint"
  }
}

ResponseUpdate multiple connectors

Code Block
languagejs
PUT /aspire/_api/connectors
{
  "AAABcID5GBc=connector": [{
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem",
  }   "created": 1596707252548,
  "AAABcID5GBc=":   "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 codeDescription
200Success
404Not found - a given connector identifier was not found
406Not acceptable - there was an issue validating the input



Section

Update single connector

Updates a single connector in Aspire.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/connectors/:id


Query String Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update


Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update
typestringOptional
The type of the connector
descriptionstringOptionalAn optional description of the connector


Example

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


Response

Code Block
languagejs
{
  "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 codeDescription
200Success
404Not found - a given connector identifier was not found
406Not acceptable - there was an issue validating the input



Section

Delete multiple connectors, filtered

Delete one or more multiple connectors from Aspire., filtered by a specified criteria

Panel
borderColorblack
bgColor#fafafb

DELETE POST /aspire/_api/connectors/:iddeleteAll


Body Parameters

NameTypeRequiredDescription
FilterJSONRequiredFilters retrieved connectors. Check the filter definition here


Response

Code Block
languagejs
{
  "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 codeDescription
200Success
404Not found - a given credential identifier was not found
406Not acceptable - there was an issue validating the input



Section

Delete single connector

Delete one or more connectors from Aspire.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/connectors/:id


Path and Query String Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the connector(s) to delete

Examples


Delete a single connectorExample

Code Block
languagejs
DELETE /aspire/_api/connectors/AAABcID5GBc=

Delete multiple connectors

Code Block
languagejs
DELETE /aspire/_api/connectors?id=AAABcID5GBc=&id=AAABcIueWUc=


Response

Code Block
languagejs
{
  "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 codeDescription
200Success
404Not found - a given connector identifier was not found
406Not acceptable - there was an issue validating the input



Section

Get connectors types

Lists all available connectors types

Panel
borderColorblack
bgColor#fafafb
GET /aspire/_api/connectors/type


Query String Parameters

NameTypeRequiredDescription
typestringOptionalFilter results to return only the specified type


Response

Code Block
languagejs
{
  "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 codeDescription
200Success


Section

Get specific connector type

Returns the type of a specific connector

Panel
borderColorblack
bgColor#fafafb
GET /aspire/_api/connectors/:id/type

Query String Parameters

NameTypeRequiredDescription




Response

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

Status

Response codeDescription
200Success


Section

Get connector type dxf

Returns the dxf for a specific connector type

Panel
borderColorblack
bgColor#fafafb
GET /aspire/_api/connectors/type/:typeId/dxf

Query String Parameters

NameTypeRequiredDescription




Response

Code Block
languagejs
{
  "dxf": {...}
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404Not 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
languagejs
  "filter" : {
    "ids" : ["id1", "id2", "id3"],
    "type" : "TYPE",
    "description" : "DESCRIPTION"
  }
Note
When using delete endpoints, ids in the filter are mandatory.