Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

Warning

title	Internal API

This is an internal API used for communication between nodes and is not expected to be used by others

The manager node API provides functionality that allows a manager and worker nodes to communicate.

Table of Contents

Section

Release one or more workers

Reset the status of any in memory batches that were sent to a failed worker but had not been acknowledged so the may be sent to another worker, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/manager/release/worker/:id

PUT /aspire/_api/manager/release/worker

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the failed worker node(s) whose batches must be reset

Examples

Release a single worker

Code Block

language	js

PUT /aspire/_api/manager/release/worker/AAABcID5GBc=

PUT /aspire/_api/manager/release/worker
{
  "id": ["AAABcID5GBc="]
}

Release more workers

Code Block

language	js

PUT /aspire/_api/manager/release/worker
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given worker id was not found

Section

Release one or more seeds

Used by the master manager when pausing or stopping to release all of the items for a seed from unsent batches. The manager will then forward the same to the workers, this endpoint need the at least the ADMINISTRATOR or MANAGER role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/manager/release/seed/:id

PUT /aspire/_api/manager/release/seed

Path and Request Body Parameters

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

Examples

Release a single seed

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Release multiple seeds

Code Block

language	js

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Release multiple seeds (alternative form)

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given seed id was not found

Section

Fetch one or more batches

Used by the worker to fetch a batch from the manager, this endpoint need the at least the ADMINISTRATOR or WORKER role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/manager/batch

Path and Request Body Parameters

Name	Type	Required	Description
worker	string	Required	The id of the worker asking for the batch
type	string	Required	The type of batch required scan process
tags	string	Optional	The tags this machine has
batches	number	Optional	The number of batches to fetch (default 1)

Response

Code Block

language	js

{
  "batch": {
    "id": 0,
    "type": "process",
    "connector": "myConnectorId",
    "entry": [{
      "_id": "item_id_1",
      "url": "item_url_1",
      "type": "com.accenture.aspire.connector.manager.ManagerComponent$FSItemType@filesystem",
      "status": "A",
      "action": "add",
      "timestamp": 1234567890,
      "shouldScan": true,
      "shouldProcess": true,
      "crawlRetries": 0,
      "isCrawlRootItem": false,
      "inCrawlRetries": 0
    }, {
      "_id": "item_id_2",
      "url": "item_url_2",
      "type": "com.accenture.aspire.connector.manager.ManagerComponent$FSItemType@folder",
      "status": "A",
      "action": "update",
      "timestamp": 1234567890,
      "shouldScan": true,
      "shouldProcess": true,
      "crawlRetries": 0,
      "isCrawlRootItem": false,
      "inCrawlRetries": 0
    }]
  },
  "message": "optional response message"
}

Status

Response code	Description
200	Success
406	Not acceptable - there was an issue validating the input

Section

Acknowledge one or more batches

Used by the worker node to acknowledge the worker has taken responsibility for the batch(es), this endpoint need the at least the ADMINISTRATOR or WORKER role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/manager/batch/ack/:id

PUT /aspire/_api/manager/batch/ack

Query String Parameters

Name

Type

Required

Description

type

string

Required

The type of the batch

scan
process

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the batch(es) to be acknowledged

Examples

Acknowledge a single batch

Code Block

language	js

PUT /aspire/_api/manager/batch/ack/AAABcID5GBc=?type=scan

PUT /aspire/_api/manager/batch/ack?type=scan
{
  "id": ["AAABcID5GBc="]
}

Acknowledge multiple batches

Code Block

language	js

PUT /aspire/_api/manager/batch/ack?type=scan
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given batch id was not found

Page tree

Versions Compared

Old Version 19

New Version 20

Key

Release one or more workers

Release one or more seeds

Fetch one or more batches

Acknowledge one or more batches

Page tree

Page History

Versions Compared

Old Version 19

New Version 20

Key

Release one or more workers

Release one or more seeds

Fetch one or more batches

Acknowledge one or more batches