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

Table of Contents

Section

Get all seeds

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

Pagination query string parameters

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

Section

Get all seeds, filtered

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

Pagination query string parameters

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

Filters: The seed filter definition here

Response

Code Block

language	js

{
  "seed": [
    {
      "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
      "description": "2500 test",
      "type": "filesystem",
      "seed": "\\Directory1",
	  "server": "serverId1",	
      "connector": {
        "id": "accd3396-6004-47c9-80a6-d6ae283878f5",
        "description": "NetApp Connector",
        "type": "File System"
      },
      "workflow": {
        "id": "accd3396-4820-8932-80a6-f57191283d98",
        "description": "My workflow",
        "type": "connector"
      },
      "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",
	  "server": "serverId1",	
      "connector": {
        "id": "accd3396-6004-47c9-80a6-d6ae283878f5",
        "description": "NetApp Connector",
        "type": "filesystem",
      },
      "workflow": {
        "id": "accd3396-4820-8932-80a6-f57191283d98",
        "description": "Stager Workflow",
        "type": "connector",
      },
      "priority": "medium",
      "checksum": "5647E40827A6C09CBA868294BB437CE5",
      "crawl": {
        "phase": "idle",
        "state": "never"
      },
 	  "properties": { This will be a dynamic JSON object } 
    }
  ]
}

Status: 200

Section

Get a single seed

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

Panel

borderColor	black
bgColor	#fafafb

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

Code Block

language	js

{
  "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: 200, 404

Section

Add seed(s)

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

Panel

borderColor	black
bgColor	#fafafb

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) - see Connectors API
description	string	Required	An description of the seed
server	string	Required	a server id - see Servers API
credential	string	Optional	An optional id of the credential to use for this seed - see Credentials API
throttlePolicy	string	Optional	a throttle policy id - see Policies API
routingPoliciespolicies	string	Optional	An optional list of the routing policy identifiers to use for this seed - see Policies API
workflows	string	Optional	An optional list of the workflow identifiers to use for this seed - see Workflow API
tags	string	Optional	An optional list of the tags to use for this seed

Example

Code Block

language	js

POST /aspire/_api/seeds
[{
	"seed":"\\Directory1",
	"connector":"connectorId",
	"server":"serverId",
	"type":"filesystem",
    "throttlePolicy": "throttlePolicyId",
    "routingPolicies": ["routingPolicyId1", "routingPolicyId2"],
    ....
},
{
  "seed":"\\Directory2",
  "connector":"connectorId",
  "server":"serverId",
  "type":"filesystem",
    ....
  "policies": ["policy_1"],
  "workflows": ["workflow_1","workflow_99"]
}]

Response

Code Block

language	js

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

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

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/seeds/:id

PUT /aspire/_api/seeds

Note
The existing document will be replaced by the new one provided in the body

Path Parameters

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

Body Parameters

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

+ fields from "Add" section...

Example for more seeds

Code Block

language	js

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",
    "policies": ["policy_1"],
    "workflows": ["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",
    "policies": ["policy_1"],
    "workflows": ["workflow_1","workflow_99"]
    "status": "N"
  },
  "properties": { This will be 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: 200, 404, 406

Section

Update seeds, filtered

Update connectors 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/seeds/updateAll

Filters: The seed filter definition here

Update body parameter:

Code Block

{
  "update" : {
    "description" : "DESCRIPTION"
	"connector" : "connectorId",
	"server" : "server",
	"tags" : ["TAG1", "TAG2", "TAG3", ...],
	"tags.add" : ["TAG1", "TAG2", "TAG3", ...],
	"tags.remove" : ["TAG1", "TAG2", "TAG3", ...],
	"workflows" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
	"workflows.add" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
	"workflows.remove" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
  }
}

Code Block

language	js

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

Status: 200, 406

Section

Delete multiple seeds, filtered

Delete multiple seeds 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/seeds/deleteAll

Filters: The seed filter definition here

Response

Code Block

language	js

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

Status: 200

Section

Delete seed(s)

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

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/seeds/:id

DELETE /aspire/_api/seeds

POST /aspire/_api/seeds/delete

Path Parameters and query parameters

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

Body parameters

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

Example

Code Block

language	js

DELETE /aspire/_api/seeds/AAABcID5GBc

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

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

Response

Code Block

language	js

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

Status: 200, 404, 406

Section

Crawl control

Start, stop, pause and resume crawls of one or more seeds, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

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

Code Block

language	js

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

Starts an full crawl for a single seed

Code Block

language	js

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

Pauses a crawl for a single seed

Code Block

language	js

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

Starts a crawl for multiple seeds

Code Block

language	js

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

Starts a crawl for multiple seeds (alternative)

Code Block

language	js

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

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status: 200, 404, 406

Section

Re-balance seed allocation (TODO)

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds/control/rebalance

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status: 200, 404

Section

Get seed type dxf (TODO)

Returns the dxf for a specific seed type

Panel

borderColor	black
bgColor	#fafafb

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

Path Parameters

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

Response

Code Block

language	js

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

Status: 200, 404

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

  "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

Versions Compared

Old Version 59

New Version 60

Key

Get all seeds

Get all seeds, filtered

Get a single seed

Add seed(s)

Update seed(s)

Update seeds, filtered

Delete multiple seeds, filtered

Delete seed(s)

Crawl control

Re-balance seed allocation (TODO)

Get seed type dxf (TODO)

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 59

New Version 60

Key

Get all seeds

Get all seeds, filtered

Get a single seed

Add seed(s)

Update seed(s)

Update seeds, filtered

Delete multiple seeds, filtered

Delete seed(s)

Crawl control

Re-balance seed allocation (TODO)

Get seed type dxf (TODO)

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor