Versions Compared

Old Version 2

changes.mady.by.user Steve Denny

Saved on

compared with

New Version Current

changes.mady.by.user Petr Podsednik

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titlePage in developmentInternal API

This page is in development and as such, its contents may be incorrectis an internal API used for the communication between nodes and is not expected to be used by others.

The manager node The connector API provides functionality that allows a administrator to perform actions such as adding and configuring connectors

Table of Contents

manager and worker nodes to communicate.

Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Success

: 200, 404

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 they may be sent to another worker. This endpoint needs at least the ADMINISTRATOR or MANAGER role to be executed.

Section

List connectors

Lists all the connectors configured in the Aspire

Panel
borderColorblack
bgColor#fafafb

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

PUT

GET

/aspire/_api/manager/

connector

release/worker

Path and Request Body Query String Parameters

NameTypeRequiredDescription
typeidstringOptionalFilter returned connectors to only those with the given type
descriptionstringOptionalFilter returned connectors to only those whose description matches the given expression

Response

RequiredThe identifier(s) of the failed worker node(s) whose batches must be reset

Examples

Release a single worker

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/release/worker/AAABcID5GBc=

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

Release more workers

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/release/worker
{
,
    "type": "filesystem",
    "description": "NetApp connector",
    ...
  },
  {
    "id": ["AAABcIueWUcAAABcID5GBc=",
    "type": "shareoint-online",
    "description": "SharePoint Online",
    ...
  }],AAABcIueWUc="]
}


Response

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

Status

Response codeDescription
200



: 200, 404

Section

Release one or more seeds

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

Get a single connector

Get information about a single connector configured in Aspire

Panel
borderColorblack
bgColor#fafafb

GET PUT /aspire/_api/connectormanager/release/seed/:id

PUT /aspire/_api/manager/release/seed

Path and Request Body Parameters

id connector to return
NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the seed to be released

Examples

Release a single seedResponse

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/release/seed/AAABcID5GBc=
 
PUT /aspire/_api/manager/release/seed
{
{
  "connector": {
    "id": ["AAABcID5GBc="]
}

Release multiple seeds

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/release/seed
{
  "id,
    "type": ["filesystemAAABcID5GBc=",
    "AAABcIueWUc="]
}

Response

Code Block
languagejs
themeRDark
{description": "NetApp connector",
    ...
  },
  "message": "optional response message"
}

Status

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



Examples

Update a single connector

Section

Fetch one or more batches

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

Section

Add connector(s)

Add one or more connectors to Aspire

Panel
borderColorblack
bgColor#fafafb
POST

GET /aspire/_api/

connector

manager/batch

Path and Request Body Parameters

this connector
NameTypeRequiredDescription
workerstringRequiredThe id of the worker asking for the batch
typestringRequired

The type of

descriptionstringOptionalAn optional description of the connector

Examples

Add a single connector

batch required

  • scan
  • process
tagsstringOptionalThe tags this machine has
itemsnumberOptionalThe number of items to fetch

Response

Code Block
languagejs
themeRDark
{
  "batch": {
    "id": 0,
    "type": "filesystemprocess",
    "descriptionconnector": "NetAppmyConnectorId",
  ...
}

Add multiple connectors

Code Block
languagejs
    "entry": [{
  "type    "_id": "filesystemitem_id_1",
      "descriptionurl": "NetAppitem_url_1",
      "type": "com.accenture.aspire..
},
{
connector.manager.ManagerComponent$FSItemType@filesystem",
      "typestatus": "sharepointA",
      "descriptionaction": "SharePoint Onlineadd",
  ...
}]

Response

Code Block
languagejs
{
    "connectortimestamp": [{1234567890,
      "idshouldScan": "AAABcID5GBc="true,
      "shouldProcess": true,
      "typecrawlRetries": "filesystem"0,
      "descriptionisCrawlRootItem": "NetApp"
false,
       ..."inCrawlRetries": 0
    }, {
  {
    "type_id": "sharepointitem_id_2",
      "descriptionurl": "SharePoint Online"item_url_2",
    ...
  }],
  "message"type": "optional response message"
}

Status

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

Update connector

Update a connector in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null

Panel
borderColorblack
bgColor#fafafb
PUT /aspire_api/connector

Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update
typestringRequiredThe type of the connector
descriptionstringOptionalAn optional description of the connector
Code Block
languagejs
{
  "id": "AAABcID5GBc=",
  "connector": "c:\\testdata\\2500",
  "type": "filesystem"
}

Response

Code Block
languagejs
{
  "connector": {
    "id": "AAABcID5GBc=",
    "description": "Net App",
    "type": "filesystem",
    "status": "N"
   }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 codeDescription201Created404Not found - a given connector identifier was not found406Not acceptable - there was an issue validating the input

: 200, 406



Section

Acknowledge one or more batches

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

Section

Delete connector(s)

Delete one or more connectors from Aspire.

Panel
borderColorblack
bgColor#fafafb

DELETE PUT /aspire/_api/manager/batch/connectorack/:id

DELETE PUT /aspire/_api/connector/manager/batch/ack


Query String Parameters

NameTypeRequiredDescription
typestringRequired

The type of the batch

  • scan
  • process


Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the connectorbatch(ses) to deletebe acknowledged

Examples

Delete Acknowledge a single connectorbatch

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/batch/ack/AAABcID5GBc=?type=scan

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

Delete Acknowledge multiple connectorsbatches

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

Response

Code Block
languagejs
themeRDark

{
  "idmessage": "AAABcIueWUc="
}]optional response message"
}

Status: 200, 404

Section

Re-balance seed allocation

Allows an administrator to manually re-balance the seed to manage allocation for active crawls. This endpoint needs the ADMINISTRATOR role to be executed

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/main/rebalance


ResponseDelete multiple connectors (alternative form)

Code Block
languagejs
themeRDark
{
  "idmessage": ["AAABcID5GBc=", "AAABcIueWUc="]
}"optional response message"
}

Status: 200

Not acceptable - there was an issue validating the input

: 200, 404

Section

Crawl failed action

Allows handling the crawl failed state for the seed. This endpoint needs the ADMINISTRATOR or WORKER role to be executed

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/manager/crawlFailed/:id


Response

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

Status

Response codeDescription
200Success
404Not found - a given connector identifier was not found
406
Section

Throttle notification (Aspire 5.3)

Allows handling the throttle event happening in the connector for the seed. This endpoint needs the ADMINISTRATOR or WORKER role to be executed

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/manager/throttle/:seedId/:pauseSeedUntil


Path and Request Body Parameters

NameTypeRequiredDescription
seedIdstringRequiredThe identifier of the throttle seed
pauseSeedUntilnumberRequiredThe time in milliseconds until which the seed must be paused


Response

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

Status: 200, 404