Versions Compared

Key

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


Warning
titlePage 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
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Pagination query string parameters

Sorting query string parameters

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

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
borderColorblack
bgColor#fafafb
GET /aspire/_api/seeds

Query String Parameters

NameTypeRequiredDescription
fromintegerOptionalIndicates the initial page to be retrieved
sizeintegerOptionalSpecifies the size of results page
sortBystringOptionalField by which results are sorted
sortModestringOptional

Sort mode

  • "asc" for ascending sort,
  • "desc" for descending sort
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
borderColorblack
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

expandstringOptionalList of fields to expand, * will expand everything

Response

Code Block
languagejs
themeRDark
{
    "seedcount": [{
    {
      "idtotalItems": "191283d9-183e-4820-8932-32b1fa07d2d5",
  1
    },
    "descriptionseed": "2500 test",
[
       "seed": "c:\\testdata\\2500", {
      "connector": {
        "id": "accd3396b4adeb8c-60043deb-47c94379-80a6ad52-d6ae283878f5e2a8d219a84a",
            "descriptiontype": "NetApp Connectorfilesystem",
            "typedescription": {"pepoSeed",
            "idconnector": "filesystem16e901a5-75c7-4969-90d2-70ad299916f3",
            "nameseed": "File SystemDirectory1",
        },
        "createdpriority": 1596707252548"medium",
            "updatedchecksum": 1596707252548 "11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40",
      },
      "workflowcrawl": {
        "id": "accd3396-4820-8932-80a6-f57191283d98",
        "descriptionmanager": "My workflowmanager_192.168.0.16:40505//AAABeOQLewo=",
        "type": "connector",
        "createdmode": 1596707252548"full",
        "updated": 1596707252548 
        "phase": "idle",
          },
      "prioritystate": "mediumcompleted",
      "tags": [
          "UKstart": 1618736207176,
        "GE",
        "FRend": 1618736273635
            ]},
            "checksumconnection": "499207DDF2E673B3B33D74566D7457B598960f72-aab0-4ba1-a90e-b29d4e3c2c92",
      "crawl": {
        "managerworkflows": "manager_192.168.188.55:50505//AAABc8Mnl84=",72022651-c2f4-45a9-9e18-2b0ace529cda"
        "mode": "full",}
        "phase": "crawlStart",
        "state": "running",
]
}

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
borderColorblack
bgColor#fafafb

GET /aspire/_api/seeds/:id

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

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the seed to return


Response

Code Block
languagejs
themeRDark
        "start": 1596707252548,
{
            "nextid": 1596707252548"b4adeb8c-3deb-4379-ad52-e2a8d219a84a",
      },
    	  "propertiestype": {"filesystem",
 This will be a dynamic JSON object } 
    }"description": "pepoSeed",
     {
       "idconnector": "5d0b35d516e901a5-c94675c7-44e74969-9be590d2-97c9ad9036a370ad299916f3",
            "seed": "c:\\testdata\\2500",
   "Directory1",
   "connector": {
        "idpriority": "accd3396-6004-47c9-80a6-d6ae283878f5medium",
            "descriptionchecksum": "NetApp Connector11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40",
            "typecrawl": {
                "idmanager": "filesystemmanager_192.168.0.16:40505//AAABeOQLewo=",
          "name      "mode": "File Systemfull",
        },
        "createdphase": 1596707252548"idle",
        "updated": 1596707252548 
      },
      "workflowstate": {"completed",
        "id": "accd3396-4820-8932-80a6-f57191283d98",
        "descriptionstart": "Stager Workflow"1618736207176,
        "type": "connector",
        "createdend": 1596707252548,1618736273635
         "updated":  1596707252548 },
      },
      "priorityconnection": "medium",
      "checksum": "5647E40827A6C09CBA868294BB437CE5"98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
      "crawl": {
        "phaseworkflows": "idle",72022651-c2f4-45a9-9e18-2b0ace529cda"
        "state": "never"
      },
 	  "properties": { This will be a dynamic JSON object } 
    }
  ]
}

Status

Response codeDescription
200Success
Section
}

Status: 200, 404




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
borderColorblack
bgColor#fafafb
POST /aspire/_api/seeds/getAll


Query String Body Parameters

NameTypeRequiredDescription
fromseedintegerstringOptionalIndicates the initial page to be retrieved
sizeintegerOptionalSpecifies the size of results page
sortBystringOptionalField by which results are sorted
sortModestringOptional

Sort mode

  • "asc" for ascending sort,
  • "desc" for descending sort
expandstringOptionalList of fields to expand, * will expand everything

Body Parameters

NameTypeRequiredDescription
filterJSONRequiredFilters retrieved seeds. Check the filter definition here
RequiredThe url/path indicating the content to crawl
typestringRequiredThe 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 seed
connectionstringRequireda connection id - see Connections API
credentialstringOptionalAn optional id of the credential to use for this seed - see Credentials API
throttlePolicystringOptionala throttle policy id - see Policies API
routingPoliciesstringOptionalAn optional list of the routing policy identifiers to use for this seed - see Policies API
deleteIncrementalPolicystringOptional(from 5.0.2) A delete policy - 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
propertiesobjectOptionalSeed properties


ExampleResponse

Code Block
languagejs
themeRDark
POST /aspire/_api/seeds
[{
	{
  "seed": [
    {
      "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
      "description": "2500 test"\\Directory1",
	"connector":"connectorId",
	"connection":"connectionId",
	"type":"filesystem",
      "seedthrottlePolicy": "c:\\testdata\\2500throttlePolicyId",
      "connectorroutingPolicies": {
  ["routingPolicyId1", "routingPolicyId2"],
      "iddeleteIncrementalPolicy" : "accd3396-6004-47c9-80a6-d6ae283878f5",deletePolicyId"
    ....
},
{
  "seed":"\\Directory2",
  "descriptionconnector": "NetApp ConnectorconnectorId",
        "type": {"connection":"connectionId",
          "id"type": "filesystem",
     ....
  "routingPolicies": ["policy_1"],
  "nameworkflows": ["workflow_1","workflow_99"]
}]


Response

Code Block
languagejs
themeRDark
{
  "seed": [{
"File System"
        },
        "createdid": 1596707252548"5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
        "updatedconnector": 1596707252548 "accd3396-6004-47c9-80a6-d6ae283878f5",
      }"seed": "c:\\testdata\\2500",
      "workflowpriority": {"medium",
        "idchecksum": "accd3396-4820-8932-80a6-f57191283d985647E40827A6C09CBA868294BB437CE5",
        "descriptioncrawl": "My workflow",
  {
      "typephase": "connectoridle",
        "createdstate": 1596707252548,"never"
    }
    "updated": 1596707252548 },
  {
      }"id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "priorityconnector": "mediumconnector_1",
      "tagsdescription": [
        "UK"250,000 files",
        "GE"credential": "cred_1",
        "FR"
      ]"throttlePolicy": "policy_1",
      "checksumworkflow": ["499207DDF2E673B3B33D74566D7457B5workflow_1",
  "workflow_99"]
    "crawlseed": {"c:\\testdata\\25000",
        "managerpriority": "manager_192.168.188.55:50505//AAABc8Mnl84=medium",
        "modechecksum": "full5647E40827A6C09CBA868294BB437CE5",
    "crawl": {
      "phase": "crawlStartidle",
        "state": "runningnever",
    }
  }, 
  "startproperties": 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": {
          "id": "filesystem",
          "name": "File System"
        },
        "created": 1596707252548,
        "updated": 1596707252548 
      },
      "workflow}

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

Status: 201, 406




Query String Parameters

Section

Update seed(s)

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

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/seeds/:id

PUT /aspire/_api/seeds


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the seed to update


Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the seed to update
descriptionstringxA description
connectorstringxThe identifier of the connector configuration to use for this seed (may be omitted if type is specified) - see Connectors API
connectionstringxa connection id - see Connections API
workflowsstringxAn optional list of the workflow identifiers to use for this seed - see Workflow API
tagsstringxAn optional list of the tags to use for this seed
throttlePolicystringxa throttle policy id - see Policies API
routingPoliciesstringxAn optional list of the routing policy identifiers to use for this seed - see Policies API
deleteIncrementalPolicystringx(from 5.0.2) a delete policy id - see Policies API
propertiesobjectxSeed properties

x - at least one field must be present


Example for more seeds

Code Block
languagejs
themeRDark
PUT /aspire/_api/seeds
{
  "AAABcID5GBc=": {
        "id"id": "accd3396-4820-8932-80a6-f57191283d98AAABcID5GBc=",
        "descriptionconnector": "Stager Workflowconnector_2",
  },
  "AAABcIueWUc=": {
    "typeid": "connectorAAABcIueWUc=",
        "createdconnector": 1596707252548"connector_1",
        "updateddescription": 1596707252548 "250,000 files",
      }"routingPolicies": ["policy_1"],
      "priorityworkflows": ["mediumworkflow_1","workflow_99"]
      "checksum": "5647E40827A6C09CBA868294BB437CE5",
      "crawl": {
        "phase": "idle",
        "state": "never"
      },
 	  "properties": { This will be a dynamic JSON object } 
    }
  ]
}

Status

Response codeDescription
200Success
Section
}
}


Response

Code Block
languagejs
themeRDark
{"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 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.

Get a single seed

Get information about a single seed configured in Aspire

Panel
borderColorblack
bgColor#fafafb
GET

PUT /aspire/_api/seeds/

:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the seed to return

updateAll

Filters: The seed filter definition here

Update body parameter:

Code Block
themeRDark
{
  "update" 
NameTypeRequiredDescriptionexpandstringOptionalList of fields to expand, * will expand everything

Response

Code Block
languagejs
{ "seed"
: {
    "
id
description" : "
191283d9-183e-4820-8932-32b1fa07d2d5",
DESCRIPTION"
	"connector" : "
accd3396-6004-47c9-80a6-d6ae283878f5
connectorId",
"seed"
	"throttlePolicy" : "
c:\\testdata\\2500
throttlePolicyId",
"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 codeDescription200Success404The given seed id was not found Section
	"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
languagejs
themeRDark
{
  "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.

Add seeds

Add seeds to Aspire

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/seeds/:id

DELETE /aspire/_api/seeds

POST /aspire/_api/seeds/delete


Body Path Parameters and query parameters

NameTypeRequiredDescription
seedidstringRequiredThe url/path indicating the content to crawl
typestringRequiredThe type of connector to use for this seed (may be omitted if connector is specified)
identifier(s) of the seed(s) to delete


Body parameters

NameTypeRequiredDescription
idsconnectorstringRequiredThe identifier(s) of the connector configuration to use for this seed (may be omitted if type is specified)
descriptionstringRequiredAn optional description of the seed
credentialstringOptionalAn optional id of the credential to use for this seed
policystringOptionalAn optional list of the policy identifiers to use for this seed
workflowstringOptionalAn optional list of the workflow identifiers to use for this seed

Example

(s) to delete


Example

Code Block
languagejs
themeRDark
DELETE /aspire/_api/seeds/AAABcID5GBc

DELETE
Code Block
languagejs
POST /aspire/_api/seeds
[{
  "seed": "c:\\testdata\\2500",?id=AAABcID5GBc&id=AAABcID5GBd

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


Response

Code Block
languagejs
themeRDark
{
  "seedmessage": "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": [{
    "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 codeDescription
201Created
406Not acceptable - there was an issue validating the input
Section
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
borderColorblack
bgColor#fafafb

POST /aspire/_api/seeds/deleteAll

Filters: The seed filter definition here


Response

Code Block
languagejs
themeRDark
{
  "message": "delete result response message"
}

Status: 200




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.

Panel
borderColorblack
bgColor#fafafb

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

POST /aspire/_api/seeds/control


Path Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed(s) to control


Query String Parameters

NameTypeRequiredDescription
actionstringOptional

The action to perform:

  • start
  • stop
  • pause
  • resume

Defaults to start if not specified

typestringOptional

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
languagejs
themeRDark
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control

Starts an full crawl for a single seed

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

Reprocess only errored documents from the previous crawl

Code Block
languagejs
themeRDark
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control?action=start&type=reprocess

Pauses a crawl for a single seed

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

Starts a crawl for multiple seeds

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

Starts a crawl for multiple seeds (alternative)

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


Response

Code Block
languagejs
themeRDark
{
  "message": "optional response message"
}

Status: 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.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/seeds/export

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

POST /aspire/_api/seeds/exportAll

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

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed(s) to export


Body Parameter

Update seeds

Update seeds in Aspire.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/seeds

Body Parameters

NameTypeRequiredDescription
ididsstringRequiredThe identifier(s) of the seed(s) to updateexportseed


Examples

string
Code Block
RequiredThe url / path indicating the content to crawl
typestringRequiredThe 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)
descriptionstringOptionalAn optional description of the seed
credentialstringOptionalAn optional id of the credential to use for this seed
policystringOptionalAn optional list of the policy identifiers to use for this seed
workflowstringOptionalAn optional list of the workflow identifiers to use for this seed
languagejs
themeRDark
GET /aspire/_api/seeds/export/AAABcID5GBc

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

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


Response

Code Block
languagejs
themeRDark
{
  "export": {
    "seeds": {
      "seed": [
        {
      

Example

Code Block
languagejs
PUT /aspire/_api/seeds
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=<seed_id>",
    "seed": "c:\\testdata\\2500",
      "type": "filesystemrest-api",
   },
  "AAABcIueWUc=": {
    "iddescription": "AAABcIueWUc=REST",
     "seed": "c:\\testdata\\250000",
    "connector": "connector<connector_1id>",
    "description": "250,000 files",
    "credentialseed": "cred_1N\/A",
    "policy": "policy_1",
      "workflowpriority": ["workflow_1medium","workflow_99"]
  }
}

Response

Code Block
languagejs
{
   "seed": [{
    "idchecksum": "AAABcID5GBc=eb4b51659226093casdf3854sdf8f67e4f0de8217c0fd86ea565ce0",
    "seed": "c:\\testdata\\2500",
      "typeconnection": "filesystem<connection_id>",
    "status": "N"
     },
   "properties": {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "seed": "c:\\testdata\\250000N\/A",
     "connector": "connector_1",
       "descriptioncrawlRules": "250,000 files",[
    "credential": "cred_1",
    "policy": "policy_1",
     {
        "workflow        "conditionalScript": ["workflow_1","workflow_99"]
false,
                "statusentityType": "Nroot",
     },
           "propertiesshouldStop": {false,
   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
       ...
              }
            ],
            "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
borderColorblack
bgColor#fafafb

POST /aspire/_api/seeds/exportAll

Filters: The connection filter definition here

Response

Code Block
languagejs
themeRDark
{
  "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




Delete multiple seeds, filtered

Delete multiple seeds from Aspire, filtered by a specified criteria

Section

Import

The import usage can be found here

Section
Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/seeds/deleteAll

Body Parameters

NameTypeRequiredDescriptionfilterJSONRequiredFilters retrieved seeds. Check the filter definition here

Response

Code Block
languagejs
{
  "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 codeDescription200Success404Not found - a given credential identifier was not found406Not acceptable - there was an issue validating the input Section

Delete single seed

Delete one or more seeds from Aspire.

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/seeds/:id

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier(s) of the seed(s) to delete

Example

Code Block
languagejs
DELETE /aspire/_api/seeds/AAABcID5GBc%3D

Response

Code Block
languagejs
{
  "message": "optional response message"
}

Status

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

Crawl control

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

Panel
borderColorblack
bgColor#fafafb

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

POST /aspire/_api/seeds/control

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier(s) of the seed(s) to control

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
languagejs
POST /aspire/_api/seeds/191283d9-183e-4820-8932-32b1fa07d2d5/control

Starts an full crawl for a single seed

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

Pauses a crawl for a single seed

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

Starts a crawl for multiple seeds

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

Starts a crawl for multiple seeds (alternative)

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

Response

Code Block
languagejs
{
  "message": "optional response message"
}

Status

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

Re-balance seed allocation

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

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/seeds/control/rebalance

Response
Code Block
languagejs
{
  "message": "optional response message"
}

Status

Response codeDescription200Success404The given batch id was not found Section

Get seed type dxf

Returns the dxf for a specific seed type

Panel
borderColorblack
bgColor#fafafb
GET /aspire/_api/seeds/type/:typeId/dxf

Path Parameters

NameTypeRequiredDescriptiontypeIdstringRequiredId of the type of the seed

Response

Code Block
languagejs
{
  "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:

Credentials Seed filter:

Code Block
languagejs
themeRDark
{ 
   "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"seed" : "SEED",
	"tags "type" : ["TAG1TYPE",
    "TAG2description", : "TAG3DESCRIPTION", ...],
	"connectorstate" : "CONNECTOR_IDstate",
	"statusconnection" : "STATUSconnection",
	"workflowstags" : ["WORKFLOW_ID1TAG1", "WORKFLOWID2TAG2", "WORKFLOW_ID3TAG3", ...],
	"policiesworkflows" : ["POLICYWORKFLOW_ID1", "POLICY_ID2WORKFLOWID2", "POLICYWORKFLOW_ID3", ...]
  }
Note
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.
}