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

POST /aspire/_api/connectors/getAll

{
  "connector": [{
    "id": "AAABcID5GBc=             ....
            },
            "checksum": "2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
        },
        {
            "id": "16e901a5-75c7-4969-90d2-70ad299916f3",
            "artifact": "com.accenture.aspire:aspire-filesystem-source",
            "type": "filesystem",
            "description": "FS_Demo",
            "properties": {
                "enableFetcher": "true",
    "type": {
           "idenableFetchUrl": "filesystemtrue",
      "name": "File System"
    },
    "descriptioninfoCacheSize": "NetApp connector100",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON....
 object } 
  },
  {
    "id": "AAABcIueWUc=" },
     "type": {
      "idchecksum": "sharepoint-online0d5130e07c1e6123bcfa6c6e81850693a2e2e3d03d896c7725dd3cb536c86b62",
      "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"
}

{
  "connector": {
    "id": "AAABcID5GBc=",
    "type": {
      "id": "filesystem",
      "namechecksum": "File System2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
    },
    "description": "NetApp connector",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  }
}

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

{
  "connector": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
            "description": "NetAppFS_Demo_Test_1",
    "created": 1596707252548,
        "updatedproperties": 1596707252548,
	"properties": { This will be a dynamic JSON object } 
  }]
}

PUT /aspire/_api/connectors

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
{
                "enableFetcher": "true",
                "enableFetchUrl": "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=",
    "descriptionenableFetcher": "Sharepoint onlinetrue",
    "type": "sharepoint"
  }
}

{
  "connector": [{
            "idenableFetchUrl": "AAABcID5GBc=true",
     "description": "Net App",
    "type": "filesystem",
    "createdinfoCacheSize": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   },
   {
"100",
				.............
            },
            "idchecksum": "AAABcID5GBd=19a1ce2e3bb658c4831bbc706a13393874822bf03e1bac31a4f197770410afbb",
      "description": "Sharepoint online",}
    "type": "sharepoint",
    "created": 1596707252548,
    "updated": 1596707252548,
	"properties": { This will be a dynamic JSON object }  
   }]
}

Update

connector(s)

Updates a single connector connectors in Aspire, this endpoint need the ADMINISTRATOR role to be executed.

Path ParametersQuery String Parameters

Body Parameters

x - at least one field must be present

Example
Example - update one connector

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

Response

{
  "connector": [{
    "idenableFetcher": "AAABcID5GBc=true",
    "description": "Net App", .....
    "}
}

Example - update more connectors

PUT /aspire/_api/connectors
{
  "AAABcID5GBc=type": "filesystem",{
    "createdid": 1596707252548"AAABcID5GBc=",
    "updateddescription": "Net 1596707252548App",
	    "properties": {
 This will be a dynamic JSON object }  
   "enableFetcher": "true",
      .....
    }]
}

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

Status

Delete multiple connectors, filtered

Delete multiple connectors from Aspire, filtered by a specified criteria

Body Parameters

DELETE /aspire/_api/connectors/AAABcID5GBc=

{
  "message": "optional response message"
}

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

{
  "type": [{
    "id": "filesystem",
    "description": "Filesytem Connector",
    "coordinates": "com.accenture.aspire:aspire-filesystem-source"
  }
  ]
}

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

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

}