You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »


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

Get all seeds

Lists all the seeds configured in the Aspire

GET /aspire/_api/seeds

Query String Parameters

NameTypeRequiredDescription
statestringOptionalFilter returned seeds to only those with the given status(es)
typestringOptionalFilter returned seeds to only those with the given type
descriptionstringOptionalFilter returned seeds to only those whose description matches the given expression
seedstringOptionalFilter returned seeds to only those whose seed matches the given expression
$expandstringOptionalList of fields to expand, * will expand everything

Response

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

Status

Response codeDescription
200Success



Get a single seed

Get information about a single seed configured in Aspire

GET /aspire/_api/seeds/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the seed to return

Response

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

Status

Response codeDescription
200Success
404The given seed id was not found



Add seeds

Add one or more seeds to Aspire

POST /aspire/_api/seeds

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

Examples

Add a single seed

POST /aspire/_api/seeds
{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Add multiple seeds

POST /aspire/_api/seeds
[{
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
},
{
  "seed": "c:\\testdata\\250000",
  "connector": "connector_1",
  "description": "250,000 files",
  "credential": "cred_1",
  "policy": "policy_1",
  "workflow": ["workflow_1","workflow_99"]
}]

Response

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

Status

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



Update seeds

Update one or more seeds in Aspire.

PUT /aspire/_api/seeds/:id

PUT /aspire/_api/seeds

Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the seed to update
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)
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

Examples

Update a single seed

PUT /aspire/_api/seeds/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "seed": "c:\\testdata\\2500",
  "type": "filesystem"
}

Update multiple seeds

PUT /aspire/_api/seeds
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem"
  },
  "AAABcIueWUc=": {
    "id": "AAABcIueWUc=",
    "seed": "c:\\testdata\\250000",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
  }
}

Response

{
  "seed": [{
    "id": "AAABcID5GBc=",
    "seed": "c:\\testdata\\2500",
    "type": "filesystem",
    "status": "N"
   },
   {
    "id": "AAABcIueWUc=",
    "type": "filesystem",
    "seed": "c:\\testdata\\250000",
    "connector": "connector_1",
    "description": "250,000 files",
    "credential": "cred_1",
    "policy": "policy_1",
    "workflow": ["workflow_1","workflow_99"]
    "status": "N"
  },
  "properties": { This will be a dynamic JSON object }]
}

Status

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



Delete seeds

Delete one or more seeds from Aspire.

DELETE /aspire/_api/seeds/:id

DELETE /aspire/_api/seeds

Path and Query String Parameters

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

Examples

Delete a single seed

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

Delete multiple seeds

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

Response

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



Crawl control

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

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

POST /aspire/_api/seeds/control

Path, Query String and Request Body Objects

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

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

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

Starts an full crawl for a single seed

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

Pauses a crawl for a single seed

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

Starts a crawl for multiple seeds

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

Starts a crawl for multiple seeds (alternative)

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


Response

{
  "message": "optional response message"
}

Status

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



Re-balance seed allocation

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

POST /aspire/_api/seeds/control/rebalance


Response

{
  "message": "optional response message"
}

Status

Response codeDescription
200Success
404The given batch id was not found

Get seed type dxf

Returns the dxf for a specific seed type

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

Query String Parameters

NameTypeRequiredDescription




Response

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

Status

Response codeDescription
200Success
404Not found - a given service identifier was not found
  • No labels

Copyright © 2024 Accenture

Contact Us: [email protected]