Versions Compared

Old Version 98

changes.mady.by.user Petr Podsednik

Saved on

compared with

New Version 99

changes.mady.by.user Petr Podsednik

Saved on

Key

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


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

Table of Contents

Section

Get all connectors

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

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

Pagination query string parameters

Section

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.

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/connectors/getAll

Pagination query string parameters

Filters: The connector filter definition here

Response

Code Block
languagejs
{
    "count": {
        "totalItems": 2
    },
    "connector": [
        {
            "id": "AAABcID5GBc=",
948a9d99-5b71-4023-976e-14dcdc82f231",
            "artifact": "com.accenture.aspire:aspire-ldap-cache-source",
            "type": "filesystemldap",
            "description": "NetApp connector",
"LDAP",
            "properties": {
                "createdenableFetcher": 1596707252548"true",
    "updated            "enableFetchUrl": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  "true",
                "infoCacheSize": "100",
                ....
            },
  {
          "idchecksum": "AAABcIueWUc=",
2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
        },
        {
            "typeid": "sharepoint-online16e901a5-75c7-4969-90d2-70ad299916f3",
            "descriptionartifact": "SharePoint Onlinecom.accenture.aspire:aspire-filesystem-source",
            "createdtype": 1596707252548"filesystem",
            "updateddescription": 1596707252548,
	"FS_Demo",
            "properties": { This will be a dynamic JSON object }  
  }],
  "from": 100,
  "size": 10,
  "totalItems": 10000
                "enableFetcher": "true",
                "enableFetchUrl": "true",
                "infoCacheSize": "100",
            },
            "checksum": "0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62"
        }
    ]
}

Status: 200



Section

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.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/connectors/:id


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the connector to return


Response

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

Status: 200, 404



Section

Add connector(s)

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

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

Code Block
languagejs
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

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



Section

Update connector(s)

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

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/connectors/:id

PUT /aspire/_api/connectors


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update


Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update
descriptionstring

propertiesobject



Example - update one connector

Code Block
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

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


Response

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

Status: 200, 404, 406



Section

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.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/connectors/updateAll

Filters: The connector filter definition here

Update body parameter:

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


Response

Code Block
languagejs
{
  "message": "update result response message"
}

Status: 200, 406



Section

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.

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/connectors/deleteAll

Filters: The connector filter definition here

Response

Code Block
languagejs
{
  "message": "delete result response message"
}

Status: 200



Section

Delete connector(s)

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

Panel
borderColorblack
bgColor#fafafb

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

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

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

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


Response

Code Block
languagejs
{
  "message": "delete result response message"
}

Status: 200, 404, 406



Section

Get connectors types (TODO)

Lists all available connectors types

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


Section

Get specific connector type (TODO)

Returns the type of a specific connector

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


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the type to retrieve


Response

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

Status: 200


Section

Get connector type dxf (TODO)

Returns the dxf for a specific connector type

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

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

Status: 200

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Seed filter:

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