Versions Compared

Old Version 36

changes.mady.by.user Ricardo Fonseca

Saved on

compared with

New Version 37

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
fromintegerOptionalIndicates the initial page to be retrieved
sizeintegerOptionalSpecifies the size of results page
sortBystringOptionalField by which results are sorted
sortModestringOptional

Sort mode

  • "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
fromintegerOptionalIndicates the initial page to be retrieved
sizeintegerOptionalSpecifies the size of results page
sortBystringOptionalField by which results are sorted
sortModestringOptional

Sort mode

  • "asc" for ascending sort,
  • "desc" for descending sort


Body Parameters

NameTypeRequiredDescription
filterJSONRequiredFilters retrieved credentials. Check the filter definition here


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


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 multiple connectors to Aspire

Panel
borderColorblack
bgColor#fafafb
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"
},
{
  "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



Update multiple connectors

Updates multiple connectors in Aspire.

Section

Update multiple connectors

Updates multiple connectors in Aspire.

Add single connector

Add a single connector to Aspire

Panel
borderColorblack
bgColor#fafafb
POST

PUT /aspire/_api/connectors


Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update
typestringOptionalRequired
The type of this the connector
descriptionstringRequiredOptionalAn optional description of the connector


ExampleExamples

Code Block
languagejs
POSTPUT /aspire/_api/connectors
{
  "typeAAABcID5GBc=": "filesystem",
{
    "descriptionid": "NetAppAAABcID5GBc="
}

Response

Code Block
languagejs
{
,
    "connectordescription": [{ "Net App",
    "idtype": "AAABcID5GBc=filesystem",
  },
  "typeAAABcID5GBd=": "filesystem",{
    "descriptionid": "NetAppAAABcID5GBd=",
    "createddescription": "Sharepoint 1596707252548online",
    "updatedtype": 1596707252548,
	"properties": { This will be a dynamic JSON object } "sharepoint"
  }]
}

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
Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/connectors

Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the connector to updatetypestringOptional
The type of the connectordescriptionstringOptionalAn optional description of the connector

}

Response

Examples

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

Response

Code Block
languagejs
{
  "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 codeDescription200Success404Not found - a given connector identifier was not found406Not 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

NameTypeRequiredDescriptionidstringRequiredThe identifier of the connector to update

Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the connector to updatetypestringOptional
The type of the connectordescriptionstringOptionalAn optional description of the connector

Example

Code Block
languagejs
PUT /aspire/_api/connectors/AAABcID5GBc%3D
{
  {
  "connector": [{
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "NetApp"filesystem",
    "created": 1596707252548,
    "typeupdated": 1596707252548,
	"filesystem"
}

Response

Code Block
languagejs
{
  "connector": [properties": { This will be a dynamic JSON object }  
   },
   {
    "id": "AAABcID5GBcAAABcID5GBd=",
    "description": "NetSharepoint Apponline",
    "type": "filesystemsharepoint",
    "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 multiple connectors from Aspire, filtered by a specified criteria

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/connectors/deleteAll


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


Query String Parameters

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


Example

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


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.