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

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Pagination query string parameters

Sorting query string parameter

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

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors

Query String Parameters

Name Type Required Description

from integer Optional Indicates the initial page to be retrieved

size integer Optional Specifies the size of results page

sortBy string Optional Field by which results are sorted

sortMode

string

Optional

Sort mode

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

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

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The connector filter definition here

Response

Code Block

language	js
theme	RDark

{
    "connectorcount": [{
        "idtotalItems": "AAABcID5GBc="2
    },
    "typeconnector": {[
       "id": "filesystem", {
      "name": "File System"
    },
    "description"id": "NetApp connector948a9d99-5b71-4023-976e-14dcdc82f231",
      "created": 1596707252548,
      "updatedartifact": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  },
  {
"com.accenture.aspire:aspire-ldap-cache-source",
            "type": "ldap",
            "iddescription": "AAABcIueWUc=LDAP",
    "type": {
       "idproperties": "sharepoint-online",{
      "name": "Sharepoint online"
    },
    "descriptionenableFetcher": "SharePoint Onlinetrue",
    "created": 1596707252548,
            "updatedenableFetchUrl": 1596707252548"true",
	"properties": { This will be a dynamic JSON object }   
  }],
  "frominfoCacheSize": "100",
  "size": 10,
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response codeDescription200Success 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

Query String Parameters

NameTypeRequiredDescriptionfromintegerOptionalIndicates the initial page to be retrievedsizeintegerOptionalSpecifies the size of results pagesortBystringOptionalField by which results are sortedsortModestringOptional

Sort mode

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

Body Parameters

NameTypeRequiredDescriptionfilterJSONRequiredFilters retrieved credentials. Check the filter definition here

Response

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": {
                ....
            },
            "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
        },
        {
            "id": "16e901a5-75c7-4969-90d2-70ad299916f3",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "filesystem",
            "description": "FS_Demo",
            "properties": {
                "enableFetcher": "true",
                "enableFetchUrl": "true",
                "idinfoCacheSize": "filesystem100",
       "name": "File System"
    },
    "description": "NetApp connector",
....
      "created": 1596707252548,
    "updated": 1596707252548},
	"properties": { This will be a dynamic JSON object } 
  },
  {
    "id"checksum": "AAABcIueWUc=0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62",
    "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 codeDescription200Success

]
}

Status: 200

Response

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

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

Response

Code Block

language	js
theme	RDark

{
    "connector": {
        "id": "948a9d99-5b71-4023-976e-14dcdc82f231",
        "artifact": "com.accenture.aspire:aspire-ldap-cache-source",
        "type": "ldap",
        "description": "LDAP",
        "properties": {
            "enableFetcher": "true",

Section

Get a single connector

Get information about a single connector configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/:id

Query String Parameters

Name Type Required Description

id string Required The id of the connector to return

Code Block

language	js

{
  "connector": {
    "id": "AAABcID5GBc=",
    "type": {
      "idenableFetchUrl": "filesystemtrue",
      "name": "File System"
    },
    "descriptioninfoCacheSize": "NetApp connector100",
			.............
       "created": 1596707252548},
        "updatedchecksum": 1596707252548,
	"properties2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e":
 { This will be a dynamic JSON object } 
  }
}

Status

Response codeDescription200Success404The given connector id was not found Section

: 200, 404

Examples

Section

Add connector(s)

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

Add multiple connectors

Add multiple 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 The description of the connector

Example

artifact	string	Required	The name of the artifact
properties	object	Required	Connector properties

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/connectors
[
    {
        "type": "filesystem",
        "description": "NetApp"
},
{
FS Demo Test 1",
        "typeartifact": "sharepointcom.accenture.aspire:aspire-filesystem-source",
    "description": "SharePoint Online"
}]

Response

Code Block

language	js

{
  "connectorproperties": [{
    "id": "AAABcID5GBc=",
        "typeenableFetcher": "filesystemtrue",
     "description": "NetApp",
       "createdenableFetchUrl": 1596707252548,
    "updatedtrue": 1596707252548,
	"properties":  { This will be a dynamic JSON object } 
  }"infoCacheSize": "100",
   {
    "id": "BAABcID5GBc=",
    "typedeleteCheckAfterErrors": "sharepointNEVER",
			.....
        "description": "SharePoint Online"}
    },
    "created": 1596707252548,
{
        "updatedtype": 1596707252548"filesystem",
	"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

201 Created

406 Not acceptable - there was an issue validating the input

Section

 "description": "FS Demo Test 2",
        "artifact": "com.accenture.aspire:aspire-filesystem-source",
        "properties": {
            "enableFetcher": "true",
            "enableFetchUrl": "true",
            "infoCacheSize": "100",
            "deleteCheckAfterErrors": "NEVER",
			.................
        }
    }
]

Response

Code Block

language	js
theme	RDark

{
    "connector": [
        {
            "id": "8e971436-b78a-4c6d-bafb-e16f1433c6f6",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",

Update multiple connectors

Updates multiple 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

Code Block

language	js

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

Response

Code Block

language	js

{
  "connector": [{
           "iddescription": "AAABcID5GBc=FS_Demo_Test_1",
    "description": "Net App",
        "typeproperties": "filesystem",{
     "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   },
   {
      "enableFetcher": "true",
                "idenableFetchUrl": "AAABcID5GBd=true",
    "description": "Sharepoint online",
       "type": "sharepoint",
    "createdinfoCacheSize": 1596707252548,
"100",
				..........
         "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

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

NameTypeRequiredDescriptionfilterJSONRequiredFilters 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 codeDescription200Success404Not found - a given credential identifier was not found406Not 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

Query String Parameters

NameTypeRequiredDescriptionidstringRequiredThe 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 codeDescription200Success404Not found - a given connector identifier was not found406Not acceptable - there was an issue validating the input

   },
            "checksum": "c27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46"
        },
        {
            "id": "9ad25f3b-ae34-4cff-85e1-6884e5b8f070",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "filesystem",
            "description": "FS_Demo_Test_2",
            "properties": {
                "enableFetcher": "true",
                "enableFetchUrl": "true",
                "infoCacheSize": "100",
				.............
            },
            "checksum": "19a1ce2e3bb658c4831bbc706a13393874822bf03e1bac31a4f197770410afbb"
        }
    ]
}

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

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors/:id

PUT /aspire/_api/connectors

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connector to update

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connector to update
description	string	x	The description of the connector
properties	object	x	Connector properties

x - at least one field must be present

Example - update one connector

Code Block

theme	RDark

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

language	js
theme	RDark

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

language	js
theme	RDark

{"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 ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors/updateAll

Filters: The connector filter definition here

Update body parameter:

Code Block

theme	RDark

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

Response

Code Block

language	js
theme	RDark

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

Status: 200, 406

Section

Delete connector(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/connectors/:id

DELETE /aspire/_api/connectors

POST /aspire/_api/connectors/delete

Path Parameters and Query parameters

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

Body Parameter

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

Examples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/connectors/AAABcID5GBc

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

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

Response

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

Section

Delete multiple connectors, filtered

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/deleteAll

Filters: The connector filter definition here

Response

Code Block

language	js
theme	RDark

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

Status: 200

Section

Export connector(s)

Export one or more connector from Aspire, this endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/export

GET /aspire/_api/connectors/export/:id

POST /aspire/_api/connectors/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parameters

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

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connector(s) to export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/connectors/export/AAABcID5GBc

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

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

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "connectors": {
      "connector": [
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-rest-source",
          "type": "rest-api",
          "description": "RestConnector",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...
          },
          "checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
        },
		...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Get connectors types

Lists all available connectors types

Section

Export multiple connectors, filtered

Export multiple connectors from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET

POST /aspire/_api/connectors/

type

Query String Parameters

Name Type Required Description

type string Optional Filter results to return only the specified type

js

exportAll

Filters: The connection filter definition here

Response

Code Block

theme
language	js

RDark

{
  "

type

export":

[

{
    "

id

connectors":

"filesystem",

"description":

"Filesytem

Connector

,

connector"

coordinates"

"com.accenture.aspire:aspire-filesystem-source"

},

{

"id": "sharepoint-online",

"description":

"SharePoint

Online

Connector",

coordinates

id": "

com.accenture.aspire:aspire-sharepoint-online-source" }, ... ] }

Status

Response codeDescription200Success Section

Get specific connector type

Returns the type of a specific connector

Panel

borderColor	black
bgColor	#fafafb

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

Query String Parameters

NameTypeRequiredDescription

Response

Code Block

language	js

{ "type": [{ "id": "filesystem

<connector_id>",
          "artifact": "com.accenture.aspire:aspire-rest-source",
          "type": "rest-api",
          "description": "RestConnector",

"description

      "properties":

"Filesytem Connector",

 {
            "

coordinates

debug":

"com.accenture.aspire:aspire-filesystem-source" } ] }

Status

Response codeDescription200Success 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

Query String Parameters

NameTypeRequiredDescription

Response

Code Block

language	js

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

Status

false,
            "wDebug": false,
            ...
          },
          "checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
        },
		...
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

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

Credentials filter:

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Connector

Response code

Description

200

Success

404

Not found - a given service identifier was not found

Section

Filters

Anchor

FiltersAnchor

Code Block

language	js
theme	RDark

{  
  "filter" : {
    "ids" : ["id1ID1", "id2ID2", "id3ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"artifact" : }

Note

When using delete endpoints, ids in the filter are mandatory.

"ARTIFACT"
  }
}

Page tree

Versions Compared

Old Version 37

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get all connectors, filtered

Get a single connector

Get a single connector

Add connector(s)

Add multiple connectors

Update multiple connectors

Delete multiple connectors, filtered

Delete single connector

Update connector(s)

Update connectors, filtered

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Get connectors types

Export multiple connectors, filtered

Get specific connector type

Get connector type dxf

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 37

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get all connectors, filtered

Get a single connector

Get a single connector

Add connector(s)

Add multiple connectors

Update multiple connectors

Delete multiple connectors, filtered

Delete single connector

Update connector(s)

Update connectors, filtered

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Get connectors types

Export multiple connectors, filtered

Get specific connector type

Get connector type dxf

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor