Document status

Check the index status for set of documents. Useful to check if a document is ready for search.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
header Parameters
cdf-version
string

cdf version header. Use this to specify the requested CDF release.

Example: alpha
Request Body schema: application/json
required

A list of document ids you want status on

required
Array of objects
includeStatistics
boolean
Default: false

Whether or not to include statistics about the document. This gives additional insight such as the number of pages, number of vectors, etc.

Responses
200

List of documents and their status to signify if they are ready for search.

400

The response for a failed request.

post/documents/status
Request samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "includeStatistics": false
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to List documents