Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The connector 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

Section

List

Get all connectors

Lists all the seeds 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/seeds

Query String Parameters

Name Type Required Description

state string Optional Filter returned seeds to only those with the given status(es)

type string Optional Filter returned seeds to only those with the given type

description string Optional Filter returned seeds to only those whose description matches the given expression

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

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connectors/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The connector filter definition here

seedstringOptionalFilter returned seeds to only those whose seed matches the given expression

Response

Code Block

language	js
theme	RDark

{
    "seedcount": [{
        "idtotalItems": "AAABcID5GBc=",2
    "seed": "c:\\testdata\\2500",},
    "typeconnector": "filesystem",[
    "description": "2,500 files",
  {
  "status": "S",
    "start": 1584550193011,
    "stopid": 1584550267047
  }"948a9d99-5b71-4023-976e-14dcdc82f231",
   {
    "id": "AAABcIueWUc=",
    "seedartifact": "c:\\testdata\\250000com.accenture.aspire:aspire-ldap-cache-source",
            "type": "filesystemldap",
     "description": "250,000 files",
       "statusdescription": "SLDAP",
            "stopproperties": 1583240224684,
{
           "start": 1583239823374
  }],
  "messageenableFetcher": "optional response message"
}

Status

Response codeDescription200Success Section

Get a single seed

Get information about a single seed configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/seeds?id=:id

GET /aspire_api/seeds/:id

Query String and Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe id of the seed to return

Response

Code Block

language	js

{
  "seed": {
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem"true",
                "enableFetchUrl": "true",
                "infoCacheSize": "100",
    "description": "2,500 files",
    "status": "S",
    "start": 1584550193011,
 ....
            },
            "stopchecksum": 1584550267047
"2f29393b0fb89ab1d70c0df85c698214def4952467488c3df03d37baeab5d39e"
        },
        {
            "messageid": "optional response message"
}

Status

Response codeDescription200Success404The given seed id was not found Section

Add seed(s)

Add one or more seeds to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/seeds

Request Body Parameters

NameTypeRequiredDescriptionseedstringRequiredThe url/path indicating the content to crawltypestringRequiredThe type of connector to use for this seed (may be omitted if connector is specified)connectorstringRequiredThe identifier of the connector configuration to use for this seed (may be omitted if type is specified)descriptionstringOptionalAn optional description of the seedcredentialstringOptionalAn optional id of the credential to use for this seedpolicystringOptionalAn optional list of the policy identifiers to use for this seedworkflowstringOptionalAn optional list of the workflow identifiers to use for this seed

Examples

Add a single seed

Code Block

language	js

{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Add multiple seeds

Code Block

language	js

[{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "seed": "c:\\testdata\\250000",
  "connector": "connector_1",
  "description": "250,000 files",
  "credential": "cred_1",
  "policy": "policy_1",
  "workflow": ["workflow_1","workflow_99"]
}]

Response

Code Block

language	js

{
  "seed": [{
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
   },
   {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "seed": "c:\\testdata\\250000",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
    "status": "N"
  }],
  "message": "optional response message"
}

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input Section

Update seed(s)

Update one or more seeds in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/seeds

Request Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the seed to updateseedstringRequiredThe url/path indicating the content to crawltypestringRequiredThe type of connector to use for this seed (may be omitted if connector is specified)connectorstringRequiredThe identifier of the connector configuration to use for this seed (may be omitted if type is specified)descriptionstringOptionalAn optional description of the seedcredentialstringOptionalAn optional id of the credential to use for this seedpolicystringOptionalAn optional list of the policy identifiers to use for this seedworkflowstringOptionalAn optional list of the workflow identifiers to use for this seed

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

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

Section

Add connector(s)

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

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	The description of the connector
artifact	string	Required	The name of the artifact
properties	object	Required	Connector properties

Example

Code Block

language	js
theme	RDark

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

language	js
theme	RDark

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

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors/:id

PUT /aspire/_api/connectors

Path 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
description	string	x	The description of the connector
properties	object	x	Connector properties

x - at least one field must be present

Example - update one connector

Code Block

theme	RDark

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

language	js
theme	RDark

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

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 Aspire, filtered by a specified criteria, this endpoint need the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/connectors/updateAll

Filters: The connector filter definition here

Update body parameter:

Code Block

theme	RDark

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

Response

Code Block

language	js
theme	RDark

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

Status: 200, 406

Section

Delete connector(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/connectors/:id

DELETE /aspire/_api/connectors

POST /aspire/_api/connectors/delete

Path Parameters and Query parameters

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

Body Parameter

Name	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

Examples

Update a single seed

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Connector filter:

Code Block

language	js
theme	RDark

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

Code Block

language	js

{
  "id": "AAABcID5GBc=",
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Update multiple seeds

Code Block

language	js

[{
  "id": "AAABcID5GBc=",
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "id": "AAABcIueWUc=",
  "seed": "c:\\testdata\\250000",
  "connector": "connector_1",
  "description": "250,000 files",
  "credential": "cred_1",
  "policy": "policy_1",
  "workflow": ["workflow_1","workflow_99"]
}]

Response

Code Block

language	js

{
  "seed": [{
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
   },
   {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "seed": "c:\\testdata\\250000",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
    "status": "N"
  }],
  "message": "optional response message"
}

Status

Response codeDescription201Created404Not found - a given seed identifier was not found406Not acceptable - there was an issue validating the input Section

Delete seed(s)

Delete one or more seeds from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/seeds?id=:id

DELETE /aspire_api/seeds/:id

DELETE /aspire_api/seeds

Query String, Path and Request Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier(s) of the seed(s) to delete

Examples

Delete a single seed

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple seeds

Code Block

language	js

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Delete multiple seeds (alternative form)

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given seed identifier was not found406Not acceptable - there was an issue validating the input Section

Crawl control

Start, stop, pause and resume crawls of one or more seeds.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/seeds/crawl?id=:id&action=:action&type=:type

GET /aspire_api/seeds/crawl/:id

GET /aspire_api/seeds/crawl/:id/:action

GET /aspire_api/seeds/crawl/:id/:action/:type

POST /aspire_api/seeds/crawl

POST /aspire_api/seeds/crawl/:action

POST /aspire_api/seeds/crawl/:action/:type

Query String, Path and Request Body Objects

NameTypeRequiredDescriptionidstringRequiredThe identifier(s) of the seed(s) to controlactionstringOptional

The action to perform:

start
stop
pause
resume
abort

Defaults to start if not specified

typestringOptional

The type of crawl to start:

incremental
full
test

Defaults to incremental if not specified

Examples

Starts a crawl for a single seed

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Starts a crawl for multiple seeds

Code Block

language	js

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Starts a crawl for seeds (alternative form)

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404Not found - a given seed identifier was not found406Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get a single seed

Add seed(s)

Update seed(s)

Get a single connector

Add connector(s)

Update connector(s)

Update connectors, filtered

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Export multiple connectors, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Delete seed(s)

Crawl control

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

Get all connectors

Get all connectors, filtered

Get a single seed

Add seed(s)

Update seed(s)

Get a single connector

Add connector(s)

Update connector(s)

Update connectors, filtered

Delete connector(s)

Delete multiple connectors, filtered

Export connector(s)

Export multiple connectors, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Delete seed(s)

Crawl control

Filters
Anchor
FiltersAnchor
FiltersAnchor