v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1344223223.6 KB
indexing

Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

post/v1/indexing/{+name}/items:poll

Path parameters

namestring required

The name of the Data Source to poll items. Format: datasources/{source_id}

Request body

limitinteger

Maximum number of items to return. The maximum value is 100 and the default value is 20.

queuestring

Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.

connectorNamestring

The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}

statusCodesstring[]

Limit the items polled to the ones with these statuses.

Response

Successful response