You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 95 Next »


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

Get all connectors

Lists all the connectors configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed. 

GET /aspire/_api/connectors

Pagination query string parameters

Get all connectors, filtered

Lists connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

POST /aspire/_api/connectors/getAll

Pagination query string parameters

Filters: The connector filter definition here

Response

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



Get a single connector

Get information about a single connector configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.

GET /aspire/_api/connectors/:id


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the connector to return


Response

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

Status: 200, 404



Add connector(s)

Add connectors to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

POST /aspire/_api/connectors


Body Parameters

NameTypeRequiredDescription
typestringRequiredThe type of this connector
descriptionstringRequiredAn optional description of the connector
artifactstringRequiredThe name of the artifact
propertiesobjectRequiredConnector properties


Example

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

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



Update connector(s)

Updates connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.

PUT /aspire/_api/connectors/:id

PUT /aspire/_api/connectors

For the connector these fields can be updated: description, properties


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update


Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update
.........
...

+ fields from "Add" section...


Example - update one connector

PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe
{
    "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe",
    "description": "NetApp - First- UPDATE",
    "properties": {
      "enableFetcher": "true",
      .....
    }
}


Example - update more connectors

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "properties": {
      "enableFetcher": "true",
      .....
    }
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "properties": {
      "enableFetcher": "true",
      .....
    }
  }
}


Response

{"response":{"updated":true,"id":"AAABcID5GBc="}}
{"response":{"connector":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}}

Status: 200, 404, 406



Update connectors, filtered

Update connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

PUT /aspire/_api/connectors/updateAll

Filters: The connector filter definition here

Update body parameter:

{
  "update" : {
    "description" : "DESCRIPTION"
    "properties": {
      "enableFetcher": "true",
      .....
    }
  }
}


Response

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

Status: 200, 406



Delete multiple connectors, filtered

Delete multiple connectors from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

POST /aspire/_api/connectors/deleteAll

Filters: The connector filter definition here

Response

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

Status: 200



Delete connector(s)

Delete one or more connectors from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

DELETE /aspire/_api/connectors/:id

DELETE /aspire/_api/connectors

POST /aspire/_api/connectors/delete


Path Parameters and Query parameters

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


Body Parameter

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


Examples

DELETE /aspire/_api/connectors/AAABcID5GBc

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

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


Response

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

Status: 200, 404, 406



Get connectors types (TODO)

Lists all available connectors types

GET /aspire/_api/connectors/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: 200


Get specific connector type (TODO)

Returns the type of a specific connector

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


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the type to retrieve


Response

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

Status: 200


Get connector type dxf (TODO)

Returns the dxf for a specific connector type

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


Path Parameters

NameTypeRequiredDescription
typeIdstringRequiredThe identifier of the type of connector for which we are going to retrieve the dxf


Response

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

Status: 200

Filters

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

Seed filter:

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







  • No labels

Copyright © 2024 Accenture

Contact Us: [email protected]