The Push Updates API allows external systems to push update requests into an Aspire seed. Each request will have one or more documents, each with one of the following actions: add, update and delete. The seed will then start a new incremental crawl and only process the documents that were sent on the request.
All requests will be stacked in a separate queue called fifoQueue, and each request will be processed sequentially using "first-in, first-out" policy.
Ingests push updates to the queue. This endpoint needs the OPERATOR role to be executed.
POST /aspire/_api/pushUpdates
Body Parameters
Name | Type | Required | Description |
---|---|---|---|
seedId | string | Required | The seed Id |
documents | array | Required | Array with all documents that will be pushed. |
documents.url | string | Required | Url or Id of the document. |
documents.action | string | Required | add, update or delete. |
documents.repItemType | string | Optional | Item type of the connector used for the seed. If not present Aspire will use its internal type for "pushed" documents |
documents.metadata | object | Optional | Any extra metadata required by the content source to process the document. |
Example
{ "seedId": "b6c3c23a-2e4d-415a-8499-afd23815a5ad", "documents": [ { "url": "file://C:tmp/test.txt", "action": "add", "repItemType": "FilesystemItemType@file", "metadata": { "displayUrl": "C:\\tmp\\test.txt", "fetchUrl": "file:///C:/tmp/test.txt", "connectorSpecific": { "field": [ { "@name": "bigBlb", "$": "PePo" } ] } } } ] }
Response
{ "documents":{ "url": "file://C:/tmp/test.txt", "pushQueueId": "f6c3c23a-2e4d-415a-8499-afd23815a599" } }
Status: 200
Check queue item status. This endpoint needs the OPERATOR role to be executed.
GET /aspire/_api/pushUpdates/:itemId
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
itemId | string | Required | The queue item id (see "pushQueueId" in the response field above) |
Examples
Get queue item status
GET /aspire/_api/pushUpdates/f6c3c23a-2e4d-415a-8499-afd23815a599
Response
{ "pushQueueId": "f6c3c23a-2e4d-415a-8499-afd23815a599", "status": "A" }
Status: 200, 404