Versions Compared

Old Version 109

changes.mady.by.user Pablo Bonilla

Saved on

compared with

New Version Current

changes.mady.by.user Manuel Marin

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.

Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-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
borderColorblack
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
borderColorblack
bgColor#fafafb

POST /aspire/_api/connectors/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The connector filter definition here

Response

Code Block
languagejs
themeRDark
{
    "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
borderColorblack
bgColor#fafafb

GET /aspire/_api/connectors/:id


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the connector to return


Response

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



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
descriptionstringRequiredThe description of the connector
artifactstringRequiredThe name of the artifact
propertiesobjectRequiredConnector properties


Example

Code Block
languagejs
themeRDark
POST /aspire/_api/connectors
[
    {
        "type": "filesystem",
        "description": "FS Demo Test 1",
        "artifact": "com.accenture.aspire:aspire-filesystem-source",
        "properties": {
            "enableFetcher": "true",
            "enableFetchUrl": "true",
            "infoCacheSize": "100",
            "deleteCheckAfterErrors": "NEVER",
			.....
        }
    },
    {
        "type": "filesystem",
        "description": "FS Demo Test 2",
        "artifact": "com.accenture.aspire:aspire-filesystem-source",
        "properties": {
            "enableFetcher": "true",
            "enableFetchUrl": "true",
            "infoCacheSize": "100",
            "deleteCheckAfterErrors": "NEVER",
			.................
        }
    }
]


Response

Code Block
languagejs
themeRDark
{
    "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
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
descriptionstringxThe description of the connector
propertiesobjectxConnector properties

x - at least one field must be present


Example - update one connector

Code Block
themeRDark
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
themeRDark
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
themeRDark
{"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
borderColorblack
bgColor#fafafb

PUT /aspire/_api/connectors/updateAll

Filters: The connector filter definition here

Update body parameter:

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


Response

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

Status: 200, 406




Body Parameter

Examples

Section

Delete

multiple connectors, filtered

connector(s)

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

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/connectors/:id

DELETE /aspire/_api/connectors

POST /aspire/_api/connectors/deleteAll

Filters: The connector filter definition here

Response

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

Status: 200

Section

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
themeRDark
DELETE /

Delete connector(s)

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

Panel
borderColorblack
bgColor#fafafb
DELETE /
aspire/_api/connectors/
:idDELETE 
AAABcID5GBc

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

POST /aspire/_api/connectors/delete

Path Parameters and Query parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the connector(s) to delete
NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the connector(s) to delete

{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}


Response

Code Block
languagejs
themeRDark
{
  "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
borderColorblack
bgColor#fafafb

POST

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

deleteAll

Filters: The connector filter definition here

Response

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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the connector(s) to export


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the connector(s) to export


Examples

Code Block
languagejs
themeRDark
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
languagejs
themeRDark
{
  "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
borderColorblack
bgColor#fafafb

POST /aspire/_api/connectors/exportAll

Filters: The connection filter definition here

Response

Code Block
languagejs
themeRDark
{
  "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 hereStatus: 200, 404, 406




Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Connector filter:

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