Versions Compared

Old Version 2

changes.mady.by.user Steve Denny

Saved on

compared with

New Version 3

changes.mady.by.user Steve Denny

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The configuration and control API provides functionality that allows a administrator to perform actions such as adding a seed to crawl, or beginning or stopping a crawl. This API will provide the functionality required by the Aspire User interface and will be extensively used by it. The API will also be used by any external process (or script) that needs to control Aspire

Table of Contents

Seed API

Section

List seeds

Lists all the seeds configured in the Aspire

Panel
borderColorblack
bgColor#fafafb
GET /aspire_api/seeds

Parameters

NameTypeDescription
statestringFilter returned seeds to only those with the given status(es)
typestringFilter returned seeds to only those with the given type
descriptionstringFilter returned seeds to only those whose description matches the given expression
seedstringFilter returned seeds to only those whose seed matches the given expression

Response

Code Block
languagejs
{
  "seed": [{
    "sid": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "description": "2,500 files",
    "status": "S",
    "start": 1584550193011,
    "stop": 1584550267047
  },
  {
    "sid": "AAABcIueWUc=",
    "seed": "c:\\testdata\\250000",
    "type": "filesystem",
    "description": "250,000 files",
    "status": "S",
    "stop": 1583240224684,
    "start": 1583239823374
  }]
}

Status

Response codeDescription
200Success
Section

Get a single seed

Get information about a single seed configured in Aspire

Panel
borderColorblack
bgColor#fafafb
GET /aspire_api/seeds/:seed_id

Response

Code Block
languagejs
{
  "seed": {
    "sid": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "description": "2,500 files",
    "status": "S",
    "start": 1584550193011,
    "stop": 1584550267047
  }
}

Status

Response codeDescription
200Success
404The given seed id was not found
Section

Add seed(s)

Add one or more seeds to Aspire

Panel
borderColorblack
bgColor#fafafb
POST /aspire_api/seeds

Parameters

NameTypeDescription
seedstringRequired: The url/path indicating the content to crawl
typestringRequired: The type of connector to use for this seed (may be omitted if connector is specified)
connectorstringRequired: The identifier of the connector configuration to use for this seed (may be omitted if type is specified)
descriptionstringAn optional description of the seed
credentialstringAn optional id of the credential to use for this seed
policystringAn optional list of the policy identifiers to use for this seed
workflowstringAn optional list of the workflow identifiers to use for this seed

Examples

Add a single seed

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

Add multiple seeds

Code Block
languagejs
{
  "seed": [{
    "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
languagejs
{
  "seed": [{
    "sid": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
   },
   {
    "sid": "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"
  }]
}

Status

Response codeDescription
201Created
406Not acceptable - there was an issue validating the input




Status API
Crawl Control API

Connector API

Credential API

Policy API

Workflow API

Schedule API