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

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

Pagination query string parameters

Sorting query string parameter

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

{
    "count": {
        "totalItems": 2
    },
    "connector": [
        {
            "id": "948a9d99-5b71-4023-976e-14dcdc82f231",
            "artifact": "com.accenture.aspire:aspire-ldap-cache-source",
            "type": "ldap",
            "description": "LDAP",
            "properties": {
                "enableFetcher": "true",
                "enableFetchUrl": "true",
                "infoCacheSize": "100",
                ....
            },
            "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",
                "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

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": "AAABcID5GBc=948a9d99-5b71-4023-976e-14dcdc82f231",
        "typeartifact": "filesystem"com.accenture.aspire:aspire-ldap-cache-source",
        "descriptiontype": "NetApp connectorldap",
        "createddescription": 1596707252548"LDAP",
       "updated": 1596707252548,
	"properties": {
  This will be a dynamic JSON object } 
  }
}

Status: 200, 404

"enableFetcher": "true",
            "enableFetchUrl": "true",
            "infoCacheSize": "100",
			.............
        },
        "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
    }
}

Status: 200, 404

Body Parameters

Example - update one connector

Section

Add connector(s)

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

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	The

Section

Add connector(s)

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

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 description of the connector
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": "FS Demo Test 1",
        "artifact": "com.accenture.aspire:aspire-filesystem-source",
        "properties": {
            "enableFetcher": "true",
       .....
    }
  }"enableFetchUrl": "true",
       {
     "typeinfoCacheSize": "filesystem100",
    "description": "FS Demo1",
        "artifactdeleteCheckAfterErrors": "com.accenture.aspire:aspire-filesystem-source",
"NEVER",
			.....
       "properties": {}
    },
   "enableFetcher": "true",
 {
        "enableFetchUrltype": "truefilesystem",
      ....
  "description": "FS }
Demo Test }
]

Response

Code Block

language	js

{
  "connector": [{
2",
        "idartifact": "AAABcID5GBc=com.accenture.aspire:aspire-filesystem-source",
        "typeproperties": "filesystem",
{
      "description": "FS Demo",
    "artifactenableFetcher": "com.accenture.aspire:aspire-filesystem-sourcetrue",
    "properties": {
        "enableFetcherenableFetchUrl": "true",
      .....
    }
  },
  {
    "id"infoCacheSize": "BAABcID5GBc=100",
    "type": "filesystem",
        "descriptiondeleteCheckAfterErrors": "FS Demo1",
NEVER",
			.................
       "artifact": "com.accenture.aspire:aspire-filesystem-source", }
    "properties": {
}
]

Response

Code Block

language	js
theme	RDark

{
    "connector": [
        {
            "enableFetcherid": "true8e971436-b78a-4c6d-bafb-e16f1433c6f6",
      .....
    }
  }]
}

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

Name Type Required Description

id string Required The identifier of the connector to update

description string properties object

Code Block

PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe
{
    "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe",
    "description": "NetApp - First- UPDATE",
    "properties": {
  "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "filesystem",
            "description": "FS_Demo_Test_1",
            "properties": {
                "enableFetcher": "true",
                "enableFetcherenableFetchUrl": "true",
        .....
    }
}

Example - update more connectors

Code Block

language	js

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "idinfoCacheSize": "AAABcID5GBc=100",
				..........
    "description": "Net App"       },
     "properties": {
      "enableFetcherchecksum": "truec27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46",
        .....
},
        }{
     },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=9ad25f3b-ae34-4cff-85e1-6884e5b8f070",
    "description        "artifact": "Sharepoint onlinecom.accenture.aspire:aspire-filesystem-source",
    "properties": {
        "enableFetchertype": "truefilesystem",
      .....
    }
  }
}

Response

Code Block

language	js

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

Status: 200, 404, 406

 "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

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.

Section

Update connector(s)

Updates connectors in Aspire, this endpoint need the ADMINISTRATOR

Section

Panel

borderColor	black
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

language	js

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

borderColor	black
bgColor	#fafafb

POST PUT /aspire/_api/connectors/deleteAll

Filters: The connector filter definition here

Response

Code Block

language	js

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

Status: 200

Section

: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

Delete connector(s)

Delete one or more connectors from Aspire, this endpoint need the at least 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

NameTypeRequiredDescriptionidstringRequiredThe identifier(s) of the connector(s) to delete

Body Parameter

NameTypeRequiredDescriptionidsstringRequiredThe identifier(s) of the connector(s) to delete

Examples

Code Block

language	js

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

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

Status: 200, 404, 406

Section

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

Get connectors types (TODO)

Lists all available connectors types

Panel

borderColor	black
bgColor	#fafafb

Code Block

language	js

GET

/aspire/_api/connectors

/type

Response


{
  "typeAAABcID5GBc=": [{
    "id": "filesystemAAABcID5GBc=",
    "description": "FilesytemNet ConnectorApp",
	"coordinates    "properties": "com.accenture.aspire:aspire-filesystem-source"{
  },
  {
    "idenableFetcher": "sharepoint-onlinetrue",
      .....
    "description": "SharePoint Online Connector}
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "coordinatesdescription": "com.accenture.aspire:aspire-sharepoint-online-source"
  },
  ...
  ]
}

Status: 200

Section

Get specific connector type (TODO)

Returns the type of a specific connector

Panel

borderColor	black
bgColor	#fafafb

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

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the type to retrieve

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.

Response

Code Block

language	js

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

borderColor	black
bgColor	#fafafb

GET

PUT /aspire/_api/connectors/

type/:typeId/dxf

Path Parameters

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

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

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

POST /aspire/_api/connectors/exportAll

Filters: The connection filter definition here

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

Section

Import

The import usage can be found here

Response

Code Block

language	js

{
  "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 filterConnector filter:

Code Block

language	js
theme	RDark

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

Page tree

Versions Compared

Old Version 100

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connector(s)

Add connector(s)

Update connector(s)

Update connectors, filtered

Update connector(s)

Delete multiple connectors, filtered

Delete connector(s)

Get connectors types (TODO)

Get specific connector type (TODO)

Update connectors, filtered

Get connector type dxf (TODO)

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Export multiple connectors, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 100

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connector(s)

Add connector(s)

Update connector(s)

Update connector(s)

Update connectors, filtered

Delete multiple connectors, filtered

Delete connector(s)

Get connectors types (TODO)

Get specific connector type (TODO)

Update connectors, filtered

Get connector type dxf (TODO)

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Export multiple connectors, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor