Warning

title	Page in development

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

The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectors

Table of Contents

Section

List connectors

Lists all the seeds connectors configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/seedsconnector

Query String Parameters

Optional

Name	Type	Required	Description	state	string
Filter returned seeds to only those with the given status(es)	type	string	Optional	Filter returned seeds connectors to only those with the given type
description	string	Optional	Filter returned seeds connectors to only those whose description matches the given expression	seed	string	Optional	Filter returned seeds to only those whose seed matches the given expression

Response

Code Block

language	js

{
  "seedconnector": [{
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "description": "2,500 files",
    "status": "SNetApp connector",
    "start": 1584550193011,
    "stop": 1584550267047
  },
  {
    "id": "AAABcIueWUc=",
    "seed": "c:\\testdata\\250000",
    "type": "filesystemshareoint-online",
    "description": "250,000 files",
    "status": "S",
    "stop": 1583240224684,
    "start": 1583239823374SharePoint Online",
  }],
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Section

Get a single

seed

connector

Get information about a single seed connector configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/seedsconnector?id=:id

GET /aspire_api/seedsconnector/:id

Query String and Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the seed connector to return

Response

Code Block

language	js

{
  "seedconnector": {
    "id": "AAABcID5GBc=",
    "seedconnector": "c:\\testdata\\2500",
    "type": "filesystem",
    "description": "2,500 files",
    "status": "S",
    "start": 1584550193011,
    "stop": 1584550267047
  },
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given seed connector id was not found

Section

Add

seed

connector(s)

Add one or more seeds connectors to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/seedsconnector

Request Body Parameters

Name	Type	Required	Description
seedconnector	string	Required	The url/path indicating the content to crawl
type	string	Required	The type of connector to use for this seed connector (may be omitted if connector is specified)
connector	string	Required	The identifier of the connector configuration to use for this seed connector (may be omitted if type is specified)
description	string	Optional	An optional description of the seedconnector
credential	string	Optional	An optional id of the credential to use for this seedconnector
policy	string	Optional	An optional list of the policy identifiers to use for this seedconnector
workflow	string	Optional	An optional list of the workflow identifiers to use for this seedconnector

Examples

Add a single seedconnector

Code Block

language	js

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

Add multiple seedsconnectors

Code Block

language	js

[{
  "seedconnector": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "seedconnector": "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

{
  "seedconnector": [{
    "id": "AAABcID5GBc=",
    "seedconnector": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
   },
   {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "seedconnector": "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 code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Section

Update

seed

connector(s)

Update one or more seeds connectors 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/seedsconnector

Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the seed connector to updateseed
connector	string	Required	The url/path indicating the content to crawl
type	string	Required	The type of connector to use for this seed connector (may be omitted if connector is specified)
connector	string	Required	The identifier of the connector configuration to use for this seed connector (may be omitted if type is specified)
description	string	Optional	An optional description of the seedconnector
credential	string	Optional	An optional id of the credential to use for this seedconnector
policy	string	Optional	An optional list of the policy identifiers to use for this seedconnector
workflow	string	Optional	An optional list of the workflow identifiers to use for this seedconnector

Examples

Update a single seedconnector

Code Block

language	js

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

Update multiple seedsconnectors

Code Block

language	js

[{
  "id": "AAABcID5GBc=",
  "seedconnector": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "id": "AAABcIueWUc=",
  "seedconnector": "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

{
  "seedconnector": [{
    "id": "AAABcID5GBc=",
    "seedconnector": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
   },
   {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "seedconnector": "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 code	Description
201	Created
404	Not found - a given seed connector identifier was not found
406	Not acceptable - there was an issue validating the input

Examples

Starts a crawl for a single seed

Section

Delete

seed

connector(s)

Delete one or more seeds connectors from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/seedsconnector?id=:id

DELETE /aspire_api/seedsconnector/:id

DELETE /aspire_api/seedsconnector

Query String, Path and Request Body Parameters

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

Examples

Delete a single seedconnector

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple seedsconnectors

Code Block

language	js

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

Delete multiple seeds connectors (alternative form)

Code Block

language	js

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

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given seed identifier was not found
406	Not 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

Name Type Required Description

id string Required The identifier(s) of the seed(s) to control

action

string

Optional

The action to perform:

start
stop
pause
resume
abort

Defaults to start if not specified

type

string

Optional

The type of crawl to start:

incremental
full
test

Defaults to incremental if not specified

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 code	Description
200	Success
404	Not found - a given seed connector identifier was not found
406	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 2

New Version 3

Key

List connectors

Get a single

connector

Add

connector(s)

Update

connector(s)

Delete

connector(s)

Crawl control

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

List connectors

Get a single

connector

Add

connector(s)

Update

connector(s)

Delete

connector(s)

Crawl control