The connections API provides functionality that allows a administrator to perform actions such as adding and configuring a connection to crawl, or beginning or stopping a crawl

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Section

Get all connections

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections

Pagination query string parameters

Sorting query string parameter

Section

Get all connections, filtered

Lists connections 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/connections/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
    "count": {
        "totalItems": 2
    },
    "connection": [
        {
            "id": "f0e88016-1a27-42b6-a5ae-31ab2226dbdc",
            "type": "ldap",
            "description": "LDAp-ik",
            "properties": {
                "useScript": "false",
                "useSearchBase": "true",
                "server": "ldap://localhost:20389",
                "authentication": "simple",
                "user": "cn=admin,dc=accenture,dc=com",
                "password": "Adm1n!",
                "searchBase": "dc=accenture,dc=com",
                "userQuery": "(objectClass=person)",
                "groupQuery": "(objectClass=groupOfUniqueNames)",
                "userAttributes": "<users><attribute>uid</attribute><attribute>givenName</attribute></users>",
                "userKeyAttr": "dn",
                "userNameAttr": "uid",
                "groupKeyAttr": "dn",
                "groupNameAttr": "ou",
                "groupMappingAttr": "uniqueMember",
                "groupsHoldMembers": "true",
                "userGUID": "true",
                "userGUIDName": "objectGUID",
                "isBinaryGUID": "true",
                "lowerCase": "false"
            }
        },
        {
            "id": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
            "type": "filesystem",
            "description": "Fs-ik",
            "properties": {
                "multipleStartPoints": "false",
                "url": "C:\\tmp\\ach1",
                "partialScan": "false",
                "subDirUrl": null,
                "indexContainers": "false",
                "scanRecursively": "true",
                "scanExcludedItems": "false",
                "ignoreScanErrors": "false",
                "ignoreSymLinks": "false",
                "useACLs": "false",
                "acls": null,
                "includes": ".*test1.*",
                "excludes": null
            }
        }
    ]
}

Status: 200

Section

Get a single connection

Get information about a single connection configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the connection to return

Response

Code Block

language	js
theme	RDark

{
  "connection": {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
}

Status: 200, 404

Section

Add connection(s)

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections

Body Parameters

Name	Type	Required	Description
type	string	Required	The type of server to add
description	string	Required	An optional description of the server
credential	string	Optional	Credential id can be specified for the server
deleteIncrementalPolicy	string	Optional	Delete policy id
throttlePolicy	string	Optional	Throttle policy id
routingPolicies	string array	Optional	Routing policies ids
properties	JSON	Required	Dynamic JSON object with server properties

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/connections
[{
   "type": "filesystem",
   "description": "Local storage",
   "deleteIncrementalPolicy": "deletePolicyId",
   "throttlePolicy": "throttlePolicyId",
   "routingPolicies": ["routingPolicyId1", "routingPolicyId2"],
   "properties": { This will be a dynamic JSON object }
 },
 {
   "type": "filesystem",
   "description": "Remote Storage",
   "credential": "cred_1",
   "properties": { This will be a dynamic JSON object }
}]

Response

Code Block

language	js
theme	RDark

{
  "connection": [
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type":   "filesystem",        
      "description": "Local Storage",
      "properties": { This is a dynamic JSON object}
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a4",
      "type": "smb",
      "description": "Remote Storage",
	  "credential": "cred_1",
      "properties": { This is a dynamic JSON object}
    }
  ]
}

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 connection(s)

Update connections in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connections/:id

PUT /aspire/_api/connections

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connection to update

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the connection to update
(see add connection)		x

x - at least one field must be present

Example

Code Block

language	js
theme	RDark

PUT /aspire/_api/connections
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Local Storage",
    "properties": { This is a dynamic JSON object}
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "description": "Remote Storage",
    "credential": "cred_2"
  }
}

Response

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

Section

Update connections, filtered

Update connections configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connections/updateAll

Filters: The connection filter definition here

Update body parameter

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION"
	"credential" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"properties" : {},
    "deleteIncrementalPolicy": "deletePolicyId",
	"routingPolicies" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.add" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.remove" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
  }
}

Response

Code Block

language	js
theme	RDark

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

Status: 200, 406

Body Parameter

Section

Delete

multiple connections, filtered

connection(s)

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

Panel

borderColor	black
bgColor	#fafafb

POST DELETE /aspire/_api/connections/deleteAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status: 200

Section

:id

DELETE /aspire/_api/connections

POST /aspire/_api/connections/delete

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connection(s) to delete

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connection(s) to delete

Examples

Code Block

language	js
theme	RDark

DELETE

Delete connection(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE

/aspire/_api/connections/

:idDELETE

AAABcID5GBc

DELETE /aspire/_api/connections

POST

?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connections/delete

Path Parameters and Query parameters

Name Type Required Description

id string Required The identifier(s) of the connection(s) to delete


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

Response

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

Section

Delete multiple connections, filtered

Delete multiple connections from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/deleteAll

Filters: The connection filter definition here

Response

NameTypeRequiredDescriptionidsstringRequiredThe identifier(s) of the connection(s) to deleteExamples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/connections/AAABcID5GBc

DELETE /aspire/_api/connections?id=AAABcID5GBc&id=AAABcID5GBd

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

{
  "message": "optional response message"
}

Status: 200

Section

Export connection(s)

Export one or more connections from Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/connections/export

GET /aspire/_api/connections/export/:id

POST /aspire/_api/connections/exportAll

Path Parameters and Query parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the connection(s) to export

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the connection(s) to export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/connections/export/AAABcID5GBc

DELETE /aspire/_api/connections/export?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/connections/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"
        },
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-ldap-identity-source",
          "type": "ldap-identity",
          "description": "LDAP",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...    
          },
          "checksum": "c03b3a168e0b4a5456d3df5g4caa480fb047f6459f9acac2ee65a2"
        },
        ...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Export multiple connections, filtered

Export multiple connections from 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/connections/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"
        },
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-ldap-identity-source",
          "type": "ldap-identity",
          "description": "LDAP",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...    
          },
          "checksum": "c03b3a168e0b4a5456d3df5g4caa480fb047f6459f9acac2ee65a2"
        },
        ...
      ]
    }
  }
}

Status: 200

Response

Code Block

language	js
theme	RDark

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

Status: 200, 404, 406

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Seed filter:

Code Block

language	js
theme	RDark

{ 
  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
    "deleteIncrementalPolicy": "deletePolicyId",
	"credentials" : "credentialId",
	"throttlePolicy" : "throttlePolicyId",
	"routingPolicies" : ["RP1", "RP2", "RP3", ...]
  }
}

Page tree

Versions Compared

Old Version 38

New Version 39

Key

Get all connections

Get all connections, filtered

Get a single connection

Add connection(s)

Update connection(s)

Update connections, filtered

Delete

connection(s)

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 38

New Version 39

Key

Get all connections

Get all connections, filtered

Get a single connection

Add connection(s)

Update connection(s)

Update connections, filtered

Delete

connection(s)

Delete connection(s)

Delete multiple connections, filtered

Export connection(s)

Export multiple connections, filtered

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor