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

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

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

Response

Code Block

language	js
theme	RDark

{
    "connectorcount": [{
        "idtotalItems": "AAABcID5GBc=" 2
    },
    "typeconnector": {[
       " {
            "id": "filesystem948a9d99-5b71-4023-976e-14dcdc82f231",
            "nameartifact": "File System"
com.accenture.aspire:aspire-ldap-cache-source",
        },
    "descriptiontype": "NetApp connectorldap",
    "created        "description": 1596707252548"LDAP",
           "updated": 1596707252548,
	"properties": { This
 will be a dynamic JSON object } 
  },
  {
    "idenableFetcher": "AAABcIueWUc=true",
         "type": {
      "idenableFetchUrl": "sharepoint-onlinetrue",
      "name": "Sharepoint online"
    },
    "descriptioninfoCacheSize": "SharePoint Online100",
          "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 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"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": {
      "id": "filesystem",
      "name": "File System"
 ....
            },
            "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",
                 ....
            },
      "description": "NetApp connector",
    "createdchecksum": 1596707252548,"0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62"
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  },
  {
    "id": "AAABcIueWUc=",
    "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 Section

]
}

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

Status: 200, 404

Example

Section

Add connector(s)

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

Get a single connector

Get information about a single connector configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/connectors/:id

Query String Body Parameters

id id to return

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

Response

artifact

code

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

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/connectors
[
    {

language	js

{
  "connector": {
    "idtype": "AAABcID5GBc=filesystem",
    "type": {
      "iddescription": "filesystemFS Demo Test 1",
        "nameartifact": "File System"com.accenture.aspire:aspire-filesystem-source",
    },
    "descriptionproperties": {
  "NetApp connector",
    "created": 1596707252548,
    "updatedenableFetcher": 1596707252548"true",
	"properties": { This will be a dynamic JSON object } 
  }
}

Status

Response code Description

200 Success

404 The given connector id was not found

Section

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

Code Block

language	js

POST /aspire/_api/connectors
[{
  "type": "filesystem",
  "description": "NetApp"
},
{
  "enableFetchUrl": "true",
            "infoCacheSize": "100",
            "deleteCheckAfterErrors": "NEVER",
			.....
        }
    },
    {
        "type": "sharepointfilesystem",
        "description": "SharePoint Online"
}]

Response

Code Block

language	js

{
  "connector": [{
    "id": "AAABcID5GBc=",
FS Demo Test 2",
        "typeartifact": "filesystemcom.accenture.aspire:aspire-filesystem-source",
        "descriptionproperties": "NetApp",
{
       "created": 1596707252548,
    "updatedenableFetcher": 1596707252548"true",
	"properties":  { This will be a dynamic JSON object } 
  }"enableFetchUrl": "true",
   {
         "idinfoCacheSize": "BAABcID5GBc=100",
       "type": "sharepoint",
    "descriptiondeleteCheckAfterErrors": "SharePoint Online",
NEVER",
			.................
       "created": 1596707252548, }
    "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 codeDescription201Created406Not acceptable - there was an issue validating the input Section

}
]

Response

Code Block

language	js
theme	RDark

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

Add single connector

Add a single connector to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors

Body Parameters

NameTypeRequiredDescriptiontypestringRequiredThe type of this connectordescriptionstringRequiredAn optional description of the connector

Example

Code Block

language	js

POST /aspire/_api/connectors
{
  "type": "filesystem",
            "description": "NetApp"
}

Response

Code Block

language	js

{
  "connector": [{
FS_Demo_Test_1",
            "properties": {
      "id": "AAABcID5GBc=",
    "type": "filesystem",
    "descriptionenableFetcher": "NetApptrue",
    "created": 1596707252548,
    "updated       "enableFetchUrl": 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 codeDescription201Created406Not acceptable - there was an issue validating the input Section

Update multiple connectors

Updates multiple connectors in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors

Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the connector to updatetypestringOptional
The type of the connectordescriptionstringOptionalAn optional description of the connector

Examples

Code Block

language	js

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
"true",
                "infoCacheSize": "100",
				..........
            },
            "checksum": "c27b11a3996c4dc6f3a03b79397679fa68256241a865faeef7f06271b558bb46"
        },
        {
            "id": "9ad25f3b-ae34-4cff-85e1-6884e5b8f070",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "filesystem",
            "description": "Net AppFS_Demo_Test_2",
       "type": "filesystem"
  },
  "AAABcID5GBd=properties": {
     "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "typeenableFetcher": "sharepointtrue",
  }
}

Response

Code Block

language	js

{
  "connector": [{
                "idenableFetchUrl": "AAABcID5GBc=true",
          "description": "Net App",
    "typeinfoCacheSize": "filesystem100",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   },
   {
				.............
            },
            "idchecksum": "AAABcID5GBd=19a1ce2e3bb658c4831bbc706a13393874822bf03e1bac31a4f197770410afbb",
    "description": "Sharepoint online",
    "type": "sharepoint",}
    "created": 1596707252548,
    "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

]
}

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

Status: 201, 406

Response

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

Update single connector

Updates a single connector in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors/:id

Query String 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
typedescription	string	Optionalx	The type description of the connector
descriptionproperties	string	Optional	An optional description of the connector	object	x	Connector properties

x - at least one field must be present

Example
Example - update one connector

Code Block

languagetheme	jsRDark

PUT /aspire/_api/connectors/AAABcID5GBc%3D600f70ef-7a90-4364-bdb9-7a9b5f81f6fe
{
    "id": "AAABcID5GBc=600f70ef-7a90-4364-bdb9-7a9b5f81f6fe",
    "description": "NetApp - First- UPDATE",
    "typeproperties": {
      "enableFetcher": "filesystem"true",
      .....
    }
}

ResponseExample - update more connectors

Code Block

language	js
theme	RDark

PUT /aspire/_api/connectors
{
  "connectorAAABcID5GBc=": [{
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "typeproperties": "filesystem",
{
      "createdenableFetcher": 1596707252548,
"true",
      .....
    }
 "updated": 1596707252548},
	  "propertiesAAABcID5GBd=": {
 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

200 Success

404 Not found - a given connector identifier was not found

406 Not acceptable - there was an issue validating the input

Section

"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

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

PUT /aspire/_api/connectors/

deleteAll

Body Parameters

Name Type Required Description

Filter JSON Required Filters retrieved connectors. Check the filter definition here

js

updateAll

Filters: The connector filter definition here

Update body parameter:

Code Block

theme	RDark

Code Block

language

{
  "

message

update" : {
    "description"

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

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

Response

Code Block

language	js
theme	RDark

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

Status: 200, 406

Response

Section

Delete connector(s)

Section

Delete single connector

Delete one or more connectors from Aspire., this endpoint need the ADMINISTRATOR role to be executed.
Panel
Panel
borderColor black
bgColor #fafafb
`DELETE /aspire/_api/connectors/:id`
`DELETE /aspire/_api/connectors`
`POST /aspire/_api/connectors/delete`

Path Parameters and Query String Parametersparameters
Name Type Required Description
id string Required The identifier(s) of the connector(s) to delete

ExampleBody Parameter
code
Name
language
Type

js

DELETE /aspire/_api/connectors/AAABcID5GBc=

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 Section

Get connectors types

Lists all available connectors types

Panel

borderColor	black
bgColor	#fafafb

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

Query String Parameters

Response

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Connector filter:

Code Block

language	js
theme	RDark

Name

Type

Required

Description

type

string

Optional

Filter results to return only the specified type

Code Block

language	js

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

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",
    "description": "Filesytem Connector",
    "coordinates": "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

Response codeDescription200Success404Not found - a given service identifier was not found SectionFilters AnchorFiltersAnchorFiltersAnchor

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

Credentials filter:

Code Block

language	js

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

Note

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

Page tree

Versions Compared

Old Version 34

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get all connectors, filtered

Get a single connector

Add connector(s)

Get a single connector

Add multiple connectors

Add single connector

Update multiple connectors

Update connector(s)

Update single connector

Update connectors, filtered

Delete multiple connectors, filtered

Delete connector(s)

Get connectors types

Delete multiple connectors, filtered

Export connector(s)

Export multiple connectors, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Get specific connector type

Get connector type dxf

Page tree

Page History

Versions Compared

Old Version 34

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get all connectors, filtered

Get a single connector

Add connector(s)

Get a single connector

Add multiple connectors

Add single connector

Update multiple connectors

Update connector(s)

Update single connector

Update connectors, filtered

Delete multiple connectors, filtered

Delete connector(s)

Get connectors types

Delete multiple connectors, filtered

Export connector(s)

Export multiple connectors, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Get specific connector type

Get connector type dxf

Filters
Anchor
FiltersAnchor
FiltersAnchor