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

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

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

Response

Code Block
languagejs
themeRDark
{
    "count": {
Code Block
languagejs
{
  "seed": [
    {
      "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
        "descriptiontotalItems": "2500 test"1
    },
      "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",
        }    "priority": "medium",
            "createdchecksum": 1596707252548"11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40",
            "updatedcrawl": 1596707252548{
    
      },
      "workflowmanager": {
 "manager_192.168.0.16:40505//AAABeOQLewo=",
       "id": "accd3396-4820-8932-80a6-f57191283d98",
        "descriptionmode": "My workflowfull",
        "type": "connector",
        "createdphase": 1596707252548"idle",
        "updated": 1596707252548 
      },
      "priority"state": "mediumcompleted",
      "tags": [
          "UKstart": 1618736207176,
        "GE",
        "FRend": 1618736273635
      ],
      "checksum": "499207DDF2E673B3B33D74566D7457B5"},
      "crawl": {
        "managerconnection": "manager_192.168.188.55:50505//AAABc8Mnl84=98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
        "mode": "full",
        "phaseworkflows": "crawlStart",72022651-c2f4-45a9-9e18-2b0ace529cda"
        "state": "running",}
        "start": 1596707252548,
        "next": 1596707252548
      },
   	  "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
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
        {
            "id": "5d0b35d5b4adeb8c-c9463deb-44e74379-9be5ad52-97c9ad9036a3e2a8d219a84a",
            "seedtype": "c:\\testdata\\2500"filesystem",
      "connector      "description": {"pepoSeed",
            "idconnector": "accd339616e901a5-600475c7-47c94969-80a690d2-d6ae283878f570ad299916f3",
            "descriptionseed": "NetApp ConnectorDirectory1",
            "typepriority": {"medium",
            "idchecksum": "filesystem11dde01482437ccce0fc570b3041f05ede06d2be6ad8ff18e3a3119f58593a40",
            "namecrawl": "File System"{
        },
        "createdmanager": 1596707252548,
"manager_192.168.0.16:40505//AAABeOQLewo=",
         "updated": 1596707252548 
      }"mode": "full",
       "workflow": {
        "idphase": "accd3396-4820-8932-80a6-f57191283d98idle",
        "description": "Stager Workflow",
        "typestate": "connectorcompleted",
        "created": 1596707252548,
        "updatedstart": 15967072525481618736207176,
 
      },
      "priority": "medium",
      "checksumend": "5647E40827A6C09CBA868294BB437CE5",1618736273635
      "crawl": {
     },
   "phase": "idle",
        "stateconnection": "never"98960f72-aab0-4ba1-a90e-b29d4e3c2c92",
      },
 	      "propertiesworkflows": { This will be a dynamic JSON object } 
    }
  ]
}

Status

Response codeDescription
200Success
Section
"72022651-c2f4-45a9-9e18-2b0ace529cda"
        }

Status: 200, 404




Example

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

Pagination query string parameters

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


Body Parameters

NameTypeRequiredDescription
seedstringRequiredThe url/path indicating the content to crawl
type

Get a single seed

Get information about a single seed configured in Aspire

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/seeds/:id

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

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id type of the seed to return

Response

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


Example

Code Block
languagejs
themeRDark
POST /aspire/_api/seeds
[{
	"seed":"\\Directory1",
	"connector":"connectorId",
	"connection":"connectionId",
	"type":"filesystem
Code Block
languagejs
{
  "seed": {
    "id": "191283d9-183e-4820-8932-32b1fa07d2d5",
    "connector": "accd3396-6004-47c9-80a6-d6ae283878f5",
    "seed": "c:\\testdata\\2500",
    "priority": "medium",
    "checksum": "499207DDF2E673B3B33D74566D7457B5",
    "crawlthrottlePolicy": {
  "throttlePolicyId",
    "managerroutingPolicies": "manager_192.168.188.55:50505//AAABc8Mnl84="["routingPolicyId1", "routingPolicyId2"],
      "modedeleteIncrementalPolicy" : "fulldeletePolicyId",
    ....
},
{
  "phaseseed": "crawlStart\\Directory2",
  "connector":"connectorId",
  "connection":"connectionId",
  "statetype": "runningfilesystem",
    ....
  "startroutingPolicies": 1596707252548
    },
	"properties": { This will be a dynamic JSON object } 
  }
}

Status

Response codeDescription
200Success
404The given seed id was not found
Section
["policy_1"],
  "workflows": ["workflow_1","workflow_99"]
}]


Response

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

Add seeds

Add seeds to Aspire

Panel
borderColorblack
bgColor#fafafb
POST /aspire/_api/seeds

Body Parameters

NameTypeRequiredDescription
seedstringRequiredThe 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)
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
Code Block
languagejs
POST /aspire/_api/seeds
[{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "seed": "c:\\testdata\\25000025000",
    "connectorpriority": "connector_1medium",
    "descriptionchecksum": "5647E40827A6C09CBA868294BB437CE5"250,000 files",
    "crawl": {
      "credentialphase": "cred_1idle",
      "policystate": "policy_1",never"
    }
  }, 
  "workflowproperties": ["workflow_1","workflow_99"]
}]

Response

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




Update seeds

Update seeds in Aspire.

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": "AAABcID5GBc=",
    "crawlconnector": {"connector_2",
  },
  "AAABcIueWUc=": {
    "phaseid": "idleAAABcIueWUc=",
      "stateconnector": "neverconnector_1",
    }
  }, 
"description": "250,000 files",
    "propertiesroutingPolicies": { This will be a dynamic JSON object }]
}

Status

Response codeDescription
201Created
406Not acceptable - there was an issue validating the input
Section
Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/seeds

Body Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the seed to updateseedstringRequiredThe 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)descriptionstringOptionalAn optional description of the seedcredentialstringOptionalAn optional id of the credential to use for this seedpolicystringOptionalAn optional list of the policy identifiers to use for this seedworkflowstringOptionalAn optional list of the workflow identifiers to use for this seed

Example

Code Block
languagejs
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

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

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


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.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/seeds/updateAll

Filters: The seed filter definition here

Update body parameter:

Code Block
themeRDark
{
  "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
languagejs
themeRDark
{
  "message": "update result response message"
}

Status: 200, 406




Example
Section

Delete seed(s)

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

Panel
borderColorblack
bgColor#fafafb

DELETE /aspire/_api/seeds/:id

DELETE /aspire/_api/seeds

POST /aspire/_api/seeds/delete


Path Parameters and query parameters

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


Body parameters

Response codeDescription
200Success
404Not found - a given seed identifier was not found
406Not acceptable - there was an issue validating the input
Section

Delete multiple seeds, filtered

Delete multiple seeds from Aspire, filtered by a specified criteria

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/seeds/deleteAll

Body Parameters

NameTypeRequiredDescription
filteridsJSONstringRequiredFilters retrieved seeds. Check the filter definition hereThe identifier(s) of the connector(s) to delete


ExampleResponse

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

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

POST /aspire/_api/seeds/delete
{
  "messageids": "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 codeDescription
200Success
404Not found - a given credential identifier was not found
406Not acceptable - there was an issue validating the input
Section
["AAABcID5GBc","AAABcID5GBd"]
}


Response

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

Delete single seed

Delete one or more seeds from Aspire

.

Panel
borderColorblack
bgColor#fafafb
DELETE

POST /aspire/_api/seeds/

:id

Path Parameters

deleteAll

Filters: The seed filter definition here


Response

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed(s) to delete
Code Block
languagejs

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

Response

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

Status

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

: 200




: 200, 404, 406

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

Defaults to start if not specified

typestringOptional

The type of crawl to start:

  • incremental
  • fulltest
  • identity
  • reprocess (Aspire 5.3)
  • pushupdates (Aspire 5.3)

Defaults to incremental if not specified

Examples

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
POSTPUT /aspire/_api/seeds/control
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}


Response

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

Status

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




Section

Export seed(s)

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

Panel
borderColor
Section

Re-balance seed allocation

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

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/seeds/export

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

POST /aspire/_api/seeds/control/rebalanceexportAll

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

Status

Response codeDescription
200Success
404The given batch id was not found
Section
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.


Get seed type dxf (TODO)

Returns the dxf for a specific seed type

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

Path ParametersPath Parameters and Query parameters

NameTypeRequiredDescription
typeIdidstringRequiredId of the type The identifier(s) of the seed
(s) to export


Body Parameter

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


Examples

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




Not found - a given service identifier was not found


Section

Import

The import usage can be found here

Response

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

Status

Response codeDescription
200Success
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
languagejs
themeRDark
{ 
   "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"state" : "state",
	"serverconnection" : "serverconnection",
	"tags" : ["TAG1", "TAG2", "TAG3", ...],
	"workflows" : ["WORKFLOW_ID1", "WORKFLOWID2", "WORKFLOW_ID3", ...]
  }
}