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

Get a single connector

Get information about a single connector configured in Aspire

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 Common filter

Response

Code Block

language	js
theme	RDark

{
    "connectorcount": [{
    "id": "AAABcID5GBc=",
    "typetotalItems": "filesystem",2
    "description": "NetApp connector"},
    "createdconnector": 1596707252548,[
    "updated": 1596707252548,
	"properties": { This will be{
 a dynamic JSON object } 
  },
  {
    "id": "AAABcIueWUc=948a9d99-5b71-4023-976e-14dcdc82f231",
      "type": "sharepoint-online",
      "descriptionartifact": "SharePoint Onlinecom.accenture.aspire:aspire-ldap-cache-source",
       "created": 1596707252548,
    "updatedtype": 1596707252548"ldap",
	"properties": { This will be a dynamic JSON object }  
  }],
  "from"description": 100"LDAP",
  "size          "properties": 10,
  "totalItems": 10000
}

Status: 200

Section

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connectors/:id

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe id of the connector to return

Response

Code Block

language	js

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors

Body Parameters

NameTypeRequiredDescriptiontypestringRequiredThe type of this connectordescriptionstringRequiredAn optional description of the connectorartifactstringRequiredThe name of the artifactpropertiesobjectRequiredConnector properties

Example

Code Block

language	js

POST /aspire/_api/connectors
[
  {
    "type": "filesystem",
    "description": "FS Demo",
    "artifact": "com.accenture.aspire:aspire-filesystem-source",
    "properties": {
      "enableFetcher{
                "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",
      .....
    }
  },
  {
    "typeinfoCacheSize": "filesystem100",
    "description": "FS Demo1",
            "artifact": "com.accenture.aspire:aspire-filesystem-source", ....
    "properties": {
      "enableFetcher": "true" },
      "enableFetchUrl      "checksum": "true0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62",
       .... }
    }]
  }
]

ResponseStatus: 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": "948a9d99-5b71-4023-976e-14dcdc82f231

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "FS Demo",
    "    "artifact": "com.accenture.aspire:aspire-ldap-filesystemcache-source",
        "propertiestype": {
"ldap",
        "enableFetcherdescription": "trueLDAP",
       ..... "properties": {
    }
  },
  {
    "idenableFetcher": "BAABcID5GBc=true",
    "type": "filesystem",
    "description": "FS Demo1",
    "artifactenableFetchUrl": "com.accenture.aspire:aspire-filesystem-sourcetrue",
    "properties": {
        "enableFetcherinfoCacheSize": "true100",
      			.............
    }
    }]
}

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

,
        "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
    }
}

Status: 200, 404

Update connectors, filtered

Update connectors configured in the Aspire, filtered by a specified criteria

Section

Add

Update

connector(s)

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

Panel

borderColor	black
bgColor	#fafafb

PUT POST /aspire/_api/connectors/:id

PUT /aspire/_api/connectors

Note
The existing document will be replaced by the new one provided in the body

Body Path Parameters

id identifier the to update

Name	Type	Required	Description
type	string	Required	The	type of	this connector

Body Parameters

Name

description	string	Type	Required	Description	The description of the connector
artifactid	string	Required	The identifier name of the connector to update	other parameters mentioned in the above "Add" section

Example - update one connector

artifact
properties	object	Required	Connector properties

Example

Code Block

language	js
theme	RDark

POST

Code Block

PUT /aspire/_api/connectors/600f70ef-7a90-4364-bdb9-7a9b5f81f6fe

[
    {
    "id": "600f70ef-7a90-4364-bdb9-7a9b5f81f6fe",
    "type": "filesystem",
        "description": "NetAppFS -Demo First-Test UPDATE1",
        "artifact": "blacom.accenture.aspire:aspire-filesystem-source",
       .....
}

Example - update more connectors

Code Block

language	js

PUT /aspire/_api/connectors
 "properties": {
  "AAABcID5GBc=": {
          "idenableFetcher": "AAABcID5GBc=true",
     "description": "Net App",
       "typeenableFetchUrl": "filesystemtrue",
    .....
  },
  "AAABcID5GBd=": {
    "idinfoCacheSize": "AAABcID5GBd=100",
    "description": "Sharepoint online",
        "typedeleteCheckAfterErrors": "sharepointNEVER"
    ,
			.....
      }
}

Response

Code Block

language	js

{
  "connector": [{
  }
    },
    {
        "idtype": "AAABcID5GBc=filesystem",
        "description": "Net AppFS Demo Test 2",
        "typeartifact": "com.accenture.aspire:aspire-filesystem-source",
    ....
    "properties": {
     },
   {
    "idenableFetcher": "AAABcID5GBd=true",
     "description       "enableFetchUrl": "Sharepoint onlinetrue",
      "type      "infoCacheSize": "sharepoint100",
     ......
   }]
}

See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors

Status: 200, 404, 406

Section

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/updateAll

Common filter

Update body parameter

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/deleteAll

Common filter

Response

Code Block

language	js

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

Status: 200

    "deleteCheckAfterErrors": "NEVER",
			.................
        }
    }
]

Response

Code Block

language	js
theme	RDark

{
    "connector": [
        {
            "id": "8e971436-b78a-4c6d-bafb-e16f1433c6f6",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "filesystem",
            "description": "FS_Demo_Test_1",
            "properties": {
                "enableFetcher": "true",
                "enableFetchUrl": "true",
                "infoCacheSize": "100",
				..........
            },
            "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

Body Parameter

Examples

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"
        },
		...
      ]
    }
  }
}

Section

Delete connector(s)

Delete one or more connectors from Aspire.

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

Name Type Required Description

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

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

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status: 200, 404, 406

Section

Get connectors types (TODO)

Lists all available connectors types

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

/connectors/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {

"type

"connectors": {
      "connector": [
        {
          "id": "

filesystem",

<connector_id>",

"description":

"Filesytem

Connector

, "coordinates

artifact": "com.accenture.aspire:aspire-

filesystem

rest-source",

},

{

id

type": "

sharepoint

rest-

online

api",

"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

borderColor	black
bgColor	#fafafb

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

Path Parameters

"description": "RestConnector",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...
          },
          "checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
        },
		...
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

Response

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Connector filter:

Code Block

language	js
theme	RDark

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

Name

Type

Required

Description

id

string

Required

The identifier of the type to retrieve

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 /aspire/_api/connectors/type/:typeId/dxf

Path Parameters

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

Response

Code Block

language	js

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

Status: 200

Page tree

Versions Compared

Old Version 79

New Version Current

Key

Get a single connector

Get all connectors

Get all connectors, filtered

Add connector(s)

Get a single connector

Update connectors, filtered

Add

connector(s)

Delete multiple connectors, filtered

Update connector(s)

Update connectors, filtered

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Delete connector(s)

Get connectors types (TODO)

Export multiple connectors, filtered

Get specific connector type (TODO)

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Get connector type dxf (TODO)

Page tree

Page History

Versions Compared

Old Version 79

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get a single connector

Add connector(s)

Get a single connector

Add

connector(s)

Update connectors, filtered

Delete multiple connectors, filtered

Update connector(s)

Update connectors, filtered

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Delete connector(s)

Get connectors types (TODO)

Export multiple connectors, filtered

Get specific connector type (TODO)

Import

Filters AnchorFiltersAnchorFiltersAnchor

Get connector type dxf (TODO)

Filters
Anchor
FiltersAnchor
FiltersAnchor