Get all connectors

Lists all the connectors configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed. 

Query String Parameters

{
    "count": {
        "totalItems": 2
    },
    "connector": [
        {
            "id": "948a9d99-5b71-4023-976e-14dcdc82f231",
            "artifact": "AAABcID5GBc=com.accenture.aspire:aspire-ldap-cache-source",
            "type": "filesystemldap",
            "description": "NetApp connector",
"LDAP",
            "properties": {
                "enableFetcher": "true",
         "created       "enableFetchUrl": 1596707252548"true",
      "updated": 1596707252548 
          "infoCacheSize": "100",
                ....
            },
            "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
        },
        {
            "id": "AAABcIueWUc=",
16e901a5-75c7-4969-90d2-70ad299916f3",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "shareoint-onlinefilesystem",
            "description": "SharePoint OnlineFS_Demo",
            "properties": {
                "enableFetcher": "true",
     "created           "enableFetchUrl": 1596707252548"true",
    "updated": 1596707252548 
  }            "infoCacheSize": "100",
                 ....
            },
            "checksum": "0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62"
        }
    ]
}

Update

connector(s)

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

Path and Request Body Parameters

Body Parameters

Examples

x - at least one field must be present

Example - update one Update a single connector

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

Example - update more Update multiple connectors

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "properties": {
      "typeenableFetcher": "filesystemtrue",
      .....
    }
  },
  "AAABcID5GBcAAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "description": "Sharepoint online",
    "type"properties": {
      "enableFetcher": "sharepointtrue",
      .....
    }
  }
}

Response

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

Status: 200, 404, 406

{
  "update" : {
    "description" : "

DESCRIPTION"

    "

properties": 

{
      "

enableFetcher": 

"true",
    

 .....
    }

  }
}

Status

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

Status: 200, 406

Delete

connector(s)

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

Path Parameters and Query String Parametersparameters

Examples

Delete a single connector

Body Parameter

Examples

DELETE /aspire/_api/connectors/AAABcID5GBc=

Delete multiple connectors

DELETE /aspire/_api/connectors?id=AAABcID5GBc%3DAAABcID5GBc&id=AAABcIueWUc%3DAAABcID5GBd

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

Response

{
  "message": "optionaldelete 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

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.

Filters: The connection filter definition here

Response

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

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

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