Starts a catalog reindex operation

If indexing was started earlier, and there was no reindex operation, then the extraction search will be based on the previously indexed data. If indexing has never been started, the extraction search will not be carried out.

POST /api/publicapi/v1/catalogs/{catalogId}/reindex

Starts a catalog reindex operation

cURL

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "indexModelId": "<string>",
  "workflowProcessingId": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "completed": "<string>"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

catalogId · string · required

Catalog identifier. You can find it in the list of all catalogs.

Response

200

text/plain

OK

id · string<uuid>

Unique id of the operation

indexModelId · string | null

Id of the index model used to analyze documents

workflowProcessingId · string | null

Id of the operation workflow

created · string<date-time>

Time when operation was created

completed · string | null

Time when operation was completed

currentState · enum<string>

Available options: InProgress, Failed, Completed