Page in development

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

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

Get all seeds

Lists all the seeds configured in the Aspire

GET /aspire/_api/seeds

Pagination query string parameters

Expand query string parameters: connector, workflows, server, policies

Response

{
  "seed": [
    {
      "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
      "description": "2500 test",
      "seed": "c:\\testdata\\2500",
      "connector": {
        "id": "accd3396-6004-47c9-80a6-d6ae283878f5",
        "description": "NetApp Connector",
        "type": "File System"
        "created": 1596707252548,
        "updated": 1596707252548 
      },
      "workflow": {
        "id": "accd3396-4820-8932-80a6-f57191283d98",
        "description": "My workflow",
        "type": "connector",
        "created": 1596707252548,
        "updated": 1596707252548 
      },
      "priority": "medium",
      "tags": [
        "UK",
        "GE",
        "FR"
      ],
      "checksum": "499207DDF2E673B3B33D74566D7457B5",
      "crawl": {
        "manager": "manager_192.168.188.55:50505//AAABc8Mnl84=",
        "mode": "full",
        "phase": "crawlStart",
        "state": "running",
        "start": 1596707252548,
        "next": 1596707252548
      },
   	  "properties": { This will be a dynamic JSON object } 
    },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "seed": "c:\\testdata\\2500",
      "connector": {
        "id": "accd3396-6004-47c9-80a6-d6ae283878f5",
        "description": "NetApp Connector",
        "type": "filesystem",
        "created": 1596707252548,
        "updated": 1596707252548 
      },
      "workflow": {
        "id": "accd3396-4820-8932-80a6-f57191283d98",
        "description": "Stager Workflow",
        "type": "connector",
        "created": 1596707252548,
        "updated": 1596707252548 
      },
      "priority": "medium",
      "checksum": "5647E40827A6C09CBA868294BB437CE5",
      "crawl": {
        "phase": "idle",
        "state": "never"
      },
 	  "properties": { This will be a dynamic JSON object } 
    }
  ]
}

Status

Response code	Description
200	Success

Get all seeds, filtered

Lists seeds configured in the Aspire, filtered by a specified criteria

POST /aspire/_api/seeds/getAll

Pagination query string parameters

Expand query string parameters: connector, workflows, server, policies

Filters: Check the seed filter definition here

Get a single seed

Get information about a single seed configured in Aspire

GET /aspire/_api/seeds/:id

Expand query string parameters: connector, workflows, server, policies

Path Parameters

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

Response

{
  "seed": {
    "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
    "connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
    "seed": "c:\\testdata\\2500",
    "priority": "medium",
    "checksum": "499207DDF2E673B3B33D74566D7457B5",
    "crawl": {
      "manager": "manager_192.168.188.55:50505//AAABc8Mnl84=",
      "mode": "full",
      "phase": "crawlStart",
      "state": "running",
      "start": 1596707252548
    },
	"properties": { This will be a dynamic JSON object } 
  }
}

Status

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

Add seeds

Add seeds to Aspire

POST /aspire/_api/seeds

Body Parameters

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

Example

POST /aspire/_api/seeds
[{
  "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

{
  "seed": [{
    "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
    "connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
    "seed": "c:\\testdata\\2500",
    "priority": "medium",
    "checksum": "5647E40827A6C09CBA868294BB437CE5",
    "crawl": {
      "phase": "idle",
      "state": "never"
    }
  },
  {
    "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
    "seed": "c:\\testdata\\25000",
    "priority": "medium",
    "checksum": "5647E40827A6C09CBA868294BB437CE5",
    "crawl": {
      "phase": "idle",
      "state": "never"
    }
  }, 
  "properties": { This will be a dynamic JSON object }]
}

Status

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

Update seeds

Update seeds in Aspire.

PUT /aspire/_api/seeds

Body Parameters

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

Example

PUT /aspire/_api/seeds
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem"
  },
  "AAABcIueWUc=": {
    "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

{
  "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"
  },
  "properties": { This will be a dynamic JSON object }]
}

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

Update seeds, filtered

Update connectors configured in the Aspire, filtered by a specified criteria

POST /aspire/_api/seeds/updateAll

Filters: Check the seed filter definition here

Update body parameter:

{
  "update" : {
    "description" : "DESCRIPTION"
	"connector" : "connectorId",
	"server" : "server",
	"tags" : ["TAG1", "TAG2", "TAG3", ...],
	"tagsAdd" : ["TAG1", "TAG2", "TAG3", ...],
	"tagsRemove" : ["TAG1", "TAG2", "TAG3", ...],
	"workflows" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
	"workflowsAdd" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
	"workflowsRemove" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
  }
}

Delete multiple seeds, filtered

Delete multiple seeds from Aspire, filtered by a specified criteria

POST /aspire/_api/seeds/deleteAll

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters retrieved seeds. Check the filter definition here

Response

{
  "message": "optional response message"
}

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

Status

Response code	Description
200	Success
404	Not found - a given credential identifier was not found
406	Not acceptable - there was an issue validating the input

Delete single seed

Delete one or more seeds from Aspire.

DELETE /aspire/_api/seeds/:id

Path Parameters

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

Example

DELETE /aspire/_api/seeds/AAABcID5GBc%3D

Response

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

Crawl control

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

POST /aspire/_api/seeds/:id/control

POST /aspire/_api/seeds/control

Path Parameters

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

Query String Parameters

Name

Type

Required

Description

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

Examples

Starts an incremental crawl for a single seed

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control

Starts an full crawl for a single seed

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=full

Pauses a crawl for a single seed

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=pause

Starts a crawl for multiple seeds

POST /aspire/_api/seeds/control
[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Starts a crawl for multiple seeds (alternative)

PUT /aspire/_api/seeds/control
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

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

Re-balance seed allocation

Allows an administrator to manually re-balance the seed to manager allocation for active crawls

POST /aspire/_api/seeds/control/rebalance

Response

{
  "message": "optional response message"
}

Status

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

Get seed type dxf (TODO)

Returns the dxf for a specific seed type

GET /aspire/_api/seeds/type/:typeId/dxf

Path Parameters

Name	Type	Required	Description
typeId	string	Required	Id of the type of the seed

Response

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

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Filters

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

Seed filter:

  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"state" : "state",
	"server" : "server",
	"tags" : ["TAG1", "TAG2", "TAG3", ...],
	"workflows" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
  }

Page tree

Get all seeds

Get all seeds, filtered

Get a single seed

Add seeds

Update seeds

Update seeds, filtered

Delete multiple seeds, filtered

Delete single seed

Crawl control

Re-balance seed allocation

Get seed type dxf (TODO)

Filters

Contact Us: [email protected]

Page tree

Seeds API

Get all seeds

Get all seeds, filtered

Get a single seed

Add seeds

Update seeds

Update seeds, filtered

Delete multiple seeds, filtered

Delete single seed

Crawl control

Re-balance seed allocation

Get seed type dxf (TODO)

Filters

Contact Us: [email protected]