Warning

title	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

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

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

Sorting query string parameters

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

Response

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

Sorting query string parameters

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

Filters: The seed filter definition here

Response

Code Block

language	js
theme	RDark

{
    "count

Code Block

language	js

{
  "seed": [
    {
      "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
      "description": "2500 test",
      "seed": "c:\\testdata\\2500",
      "connector": {
        "idtotalItems": "accd3396-6004-47c9-80a6-d6ae283878f5",1
    },
    "descriptionseed": [
 "NetApp Connector",
      {
  "type": "File System"
        "createdid": 1596707252548"b4adeb8c-3deb-4379-ad52-e2a8d219a84a",
            "updatedtype": 1596707252548 "filesystem",
      },
      "workflowdescription": {
"pepoSeed",
            "idconnector": "accd339616e901a5-482075c7-89324969-80a690d2-f57191283d9870ad299916f3",
            "descriptionseed": "My workflowDirectory1",
            "typepriority": "connectormedium",
            "createdchecksum": 1596707252548"11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40",
            "updatedcrawl": {
 1596707252548   
      },
      "prioritymanager": "mediummanager_192.168.0.16:40505//AAABeOQLewo=",
      "tags": [
          "UKmode",
        "GE: "full",
        "FR"
      ],
      "checksumphase": "499207DDF2E673B3B33D74566D7457B5idle",
       "crawl": {
        "managerstate": "manager_192.168.188.55:50505//AAABc8Mnl84=completed",
        "mode": "full",
        "phasestart": "crawlStart"1618736207176,
        "state": "running",
        "startend": 1596707252548,1618736273635
        "next": 1596707252548
          },
   	  "properties": { This will be a dynamic JSON object } "connection": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
    },
    {
      "idworkflows": "5d0b35d572022651-c946c2f4-44e745a9-9be59e18-97c9ad9036a32b0ace529cda",
      "seed": "c:\\testdata\\2500",  }
      "connector": {
        "id": "accd3396-6004-47c9-80a6-d6ae283878f5",]
}

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, connection, policies

Path Parameters

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

Response

Code Block

language	js
theme	RDark

        {
            "descriptionid": "NetApp Connectorb4adeb8c-3deb-4379-ad52-e2a8d219a84a",
            "type": "filesystem",
            "createddescription": 1596707252548"pepoSeed",
            "updatedconnector": 1596707252548 "16e901a5-75c7-4969-90d2-70ad299916f3",
      },
      "workflowseed": {"Directory1",
            "idpriority": "accd3396-4820-8932-80a6-f57191283d98medium",
            "descriptionchecksum": "Stager Workflow11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40",
            "typecrawl": "connector",{
        "created": 1596707252548,
        "updatedmanager": 1596707252548 "manager_192.168.0.16:40505//AAABeOQLewo=",
      },
      "priority": "medium",
      "checksummode": "5647E40827A6C09CBA868294BB437CE5full",
      "crawl": {
          "phase": "idle",
                "state": "nevercompleted",
      },
 	          "propertiesstart": {1618736207176,
 This will be a dynamic JSON object } 
          "end": 1618736273635
            },
   ]
}

Status

Response code Description

200 Success

Section

         "connection": "98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
            "workflows": "72022651-c2f4-45a9-9e18-2b0ace529cda"
        }

Status: 200, 404

Response

Section

Add seed(s)

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

Get all seeds, filtered

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds/getAll

Pagination query string parameters

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

Filters: Check the seed filter definition here

Section

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
connection	string	Required	a connection id - see Connections 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
routingPolicies	string	Optional	An optional list of the routing policy identifiers to use for this seed - see Policies API
deleteIncrementalPolicy	string	Optional	(from 5.0.2) A delete policy - 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
properties	object	Optional	Seed properties

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/seeds
[{
	"seed":"\\Directory1",
	"connector":"connectorId",
	"connection":"connectionId",
	"type":"filesystem

Get a single seed

Get information about a single seed configured in Aspire

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

Code Block

language	js

{
  "seed": {
    "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
    "connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
    "seed": "c:\\testdata\\2500",
    "prioritythrottlePolicy": "mediumthrottlePolicyId",
    "checksumroutingPolicies": "499207DDF2E673B3B33D74566D7457B5"["routingPolicyId1", "routingPolicyId2"],
    "crawldeleteIncrementalPolicy" : {"deletePolicyId"
    ....
},
{
  "managerseed": "manager_192.168.188.55:50505//AAABc8Mnl84="\\Directory2",
      "modeconnector": "fullconnectorId",
      "phaseconnection": "crawlStartconnectionId",
      "statetype": "runningfilesystem",
    ....
  "startroutingPolicies": 1596707252548["policy_1"],
    },
	"properties": { This will be a dynamic JSON object } 
  }
}

Status

Response codeDescription200Success404The given seed id was not found Section

Add seeds

Add seeds to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds

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) - see Connectors API
descriptionstringRequiredAn description of the seedserverstringRequireda server id - see Servers APIcredentialstringOptionalAn optional id of the credential to use for this seed - see Credentials APIpoliciesstringOptionalAn optional list of the policy identifiers to use for this seed - see Policies API
workflowsstringOptionalAn optional list of the workflow identifiers to use for this seed - see Workflow API
tagsstringOptionalAn 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",
    ....
},
{
  "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 }]
}

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the inputSee Response Body for details regrading

"workflows": ["workflow_1","workflow_99"]
}]

Response

Code Block

language	js
theme	RDark

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

Body Parameters

Example for more seeds

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

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
description	string	x	A description
connector	string	x	The identifier of the connector configuration to use for this seed (may be omitted if type is specified) - see Connectors API
connection	string	x	a connection id - see Connections API
workflows	string	x	An optional list of the workflow identifiers to use for this seed - see Workflow API
tags	string	x	An optional list of the tags to use for this seed
throttlePolicy	string	x	a throttle policy id - see Policies API
routingPolicies	string	x	An optional list of the routing policy identifiers to use for this seed - see Policies API
deleteIncrementalPolicy	string	x	(from 5.0.2) a delete policy id - see Policies API
properties	object	x	Seed properties

x - at least one field must be present

Example for more seeds

Code Block

language	js
theme	RDark

PUT /aspire/_api/seeds
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "connector": "connector_2",
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "connector": "connector_1",
    "description": "250,000 files",
    "routingPolicies": ["policy_1"],
    "workflows": ["workflow_1","workflow_99"]
  }
}

Response

Code Block

language	js
theme	RDark

{"seed":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}

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

seed(s)

seeds, filtered

Update

seeds

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/

:id

PUT /aspire/_api/seeds

Note
All fields will be replaced by the new ones

Path Parameters

Name Type Required Description

id string Required The identifier of the seed to update

Name Type Required Description

id string Required The identifier of the seed to update

... see parameters for Add seed

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

Status

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

Section

Update seeds, filtered

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds/updateAll

Filters: Check the seed filter definition here

Update body parameter:

Code Block

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

updateAll

Filters: The seed filter definition here

Update body parameter:

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION"
	"connector" : "connectorId",
	"throttlePolicy" : "throttlePolicyId",
	"properties" : {},
	"connection" : "connection",
	"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", ...],
	"routingPolicies" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.add" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
	"routingPolicies.remove" : ["RP_ID1", "RP_ID2", "RP_ID3", ...]
  }
}

Code Block

language	js
theme	RDark

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

Status: 200, 406

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
theme	RDark

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
theme	RDark

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

Status: 200, 404, 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
theme	RDark

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

Status: 200

Body parameters

Example

Section

Crawl control

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

Section

Delete multiple seeds, filtered

Delete multiple seeds from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

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

POST /aspire/_api/seeds/control

Path Body Parameters

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

Response

Code Block

language	js

{
  "message": "optional response message"
}

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

Section

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

Defaults to start if not specified

type

string

Optional

The type of crawl to start:

incremental
full
identity
reprocess (Aspire 5.3)
pushupdates (Aspire 5.3)

Defaults to incremental if not specified

Body

Optionally, a filter can be added to specify which seeds to start

Examples

Starts an incremental crawl for a single seed

Code Block

language	js
theme	RDark

POST

Delete seed(s)

Delete one or more seeds from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE

/aspire/_api/seeds/

:id

191283d9-183e-4820-8932-32b1fa07d2d5/control

Starts an full crawl for a single seed

Code Block

language	js
theme	RDark

POST

DELETE

/aspire/_api/seeds

?id=:id1&id=:id2..

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

Reprocess only errored documents from the previous crawl

Code Block

language	js
theme	RDark

POST

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

Name Type Required Description

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

191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=reprocess

Pauses a crawl for a single seed

Code Block

language	js
theme	RDark

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

Starts a crawl for multiple seeds

Code Block

language	js
theme	RDark

POST

Code Block

language	js

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

Starts a crawl for multiple seeds (alternative)

Code Block

language	js
theme	RDark

POST /aspire/_api/seeds/control
{
  "idsid": ["id1AAABcID5GBc=", "id2AAABcIueWUc="]
}

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status

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

: 200, 404, 406

Section

Export seed(s)

Export one or more seed from Aspire, this endpoint needs at least the OPERATOR role to be executed

Crawl control

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

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/seeds/export

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

POST /aspire/_api/seeds/controlexportAll

Path Parameters

Name Type Required Description

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

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

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the seed(s) to export

Examples

Code Block

language	js
theme	RDark

GET

Query String Parameters

NameTypeRequiredDescriptionactionstringOptional

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

/export/AAABcID5GBc

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

POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=fullexport
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

ResponsePauses 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


theme	RDark

{
  "export":

Code Block

language	js

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

Starts a crawl for multiple seeds (alternative)

Code Block

language	js

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

Response

Code Block

language	js

{

          "messagetype": "optional response message"
}

Status

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

"rest-api",
          "description": "REST",
          "connector": "<connector_id>",
          "seed": "N\/A",
          "priority": "medium",
          "checksum": "eb4b51659226093casdf3854sdf8f67e4f0de8217c0fd86ea565ce0",
          "connection": "<connection_id>",
          "properties": {
            "seed": "N\/A",
            "crawlRules": [
              {
                "conditionalScript": false,
                "entityType": "root",
                "shouldStop": false,
                ...
              }
            ],
            "stopOnScannerError": true
          }
        },
        ...
      ]
    },
    "connectors": {
      "connector": [
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-rest-source",
          "type": "rest-api",
          "description": "RestConnector",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...
          },
          "checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
        },
        ...
      ]
    },
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "RestCredentials",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
        ...
      ]
    },
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RestConnection",
          "credential": "<credential_id>",
          "properties": {
            "maxRetries": 3,
            "useThrottling": false,
            "throttling": "throttling_false",
            "useProxy": false,
            "proxy": "proxy_false",
            "trustAllCertificates": false,
            ...
          }
        },
        ...
      ]
    },
    "policies": {
      "policy": [
        {
          "id": "<policy_id>",
          "type": "throttle",
          "description": "pT",
          "period": "day",
          "value": 1
        },
        ...
      ]
    },
    "schedules": {
      "schedule": [
        {
          "id": "<schedule_id>",
          "type": "time",
          "description": "test",
          "enabled": "false",
          "scheduleTimeType": "daily",
          "stopOnFail": false,
          "schedule": "0 0 0 1\/1 * ?",
          "after": null,
          "seeds": "<seed_id>",
          "crawlMode": "full",
          "completeThreshold": 1.0,
          "action": "pause"
        },
        ...
      ]
    },
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkFlow",
          "checksum": "dc7d632e4fac3aed7404d2c260sd3f54eea266f9fd4af73b6251d6cb",
          "templates": {
            ...
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        },
        ...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Export multiple seeds, filtered

Export multiple seeds 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/seeds/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "seeds": {
      "seed": [
        {
          "id": "<seed_id>",
          "type": "rest-api",
          "description": "REST",
          "connector": "<connector_id>",
          "seed": "N\/A",
          "priority": "medium",
          "checksum": "eb4b51659226093casdf3854sdf8f67e4f0de8217c0fd86ea565ce0",
          "connection": "<connection_id>",
          "properties": {
            "seed": "N\/A",
            "crawlRules": [
              {
                "conditionalScript": false,
                "entityType": "root",
                "shouldStop": false,
                ...
              }
            ],
            "stopOnScannerError": true
          }
        },
        ...
      ]
    },
    "connectors": {
      "connector": [
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-rest-source",
          "type": "rest-api",
          "description": "RestConnector",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...
          },
          "checksum": "82a70c88cbfa46dfd79d6430bfesdf5646c13089604fb609831f16f"
        },
        ...
      ]
    },
    "credentials": {
      "credential": [
        {
          "id": "<credential_id>",
          "type": "rest-api",
          "description": "RestCredentials",
          "properties": {
            "type": "bearer",
            "query": {
              ...
            }
          }
        },
        ...
      ]
    },
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RestConnection",
          "credential": "<credential_id>",
          "properties": {
            "maxRetries": 3,
            "useThrottling": false,
            "throttling": "throttling_false",
            "useProxy": false,
            "proxy": "proxy_false",
            "trustAllCertificates": false,
            ...
          }
        },
        ...
      ]
    },
    "policies": {
      "policy": [
        {
          "id": "<policy_id>",
          "type": "throttle",
          "description": "pT",
          "period": "day",
          "value": 1
        },
        ...
      ]
    },
    "schedules": {
      "schedule": [
        {
          "id": "<schedule_id>",
          "type": "time",
          "description": "test",
          "enabled": "false",
          "scheduleTimeType": "daily",
          "stopOnFail": false,
          "schedule": "0 0 0 1\/1 * ?",
          "after": null,
          "seeds": "<seed_id>",
          "crawlMode": "full",
          "completeThreshold": 1.0,
          "action": "pause"
        },
        ...
      ]
    },
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkFlow",
          "checksum": "dc7d632e4fac3aed7404d2c260sd3f54eea266f9fd4af73b6251d6cb",
          "templates": {
            ...
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        },
        ...
      ]
    }
  }
}

Status: 200

Re-balance seed allocation (TODO)

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

Section

Import

The import usage can be found here

Section

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/seeds/control/rebalance

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response codeDescription200Success404The given batch id was not found 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

NameTypeRequiredDescriptiontypeIdstringRequiredId of the type of the seed

Response

Code Block

language	js

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

Status

Response codeDescription200Success404Not found - a given service identifier was not found

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
theme	RDark

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

Page tree

Versions Compared

Old Version 48

New Version Current

Key

Get all seeds

Get all seeds, filtered

Get a single seed

Add seed(s)

Get all seeds, filtered

Get a single seed

Add seeds

Update seed(s)

Update

seeds, filtered

Update seeds, filtered

Delete seed(s)

Delete multiple seeds, filtered

Crawl control

Delete multiple seeds, filtered

Delete seed(s)

Export seed(s)

Crawl control

Export multiple seeds, filtered

Re-balance seed allocation (TODO)

Import

Get seed type dxf (TODO)

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 48

New Version Current

Key

Get all seeds

Get all seeds, filtered

Get a single seed

Add seed(s)

Get all seeds, filtered

Get a single seed

Add seeds

Update seed(s)

Update

seeds, filtered

Update seeds, filtered

Delete seed(s)

Delete multiple seeds, filtered

Crawl control

Delete multiple seeds, filtered

Delete seed(s)

Export seed(s)

Crawl control

Export multiple seeds, filtered

Import

Re-balance seed allocation (TODO)

Get seed type dxf (TODO)

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor