Document status

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

This endpoint is in beta and is available only when a cdf-version: YYYYMMDD-beta header is provided.

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

List of document ids to check the status for.

ignoreUnknownIds
boolean
Default: false

Ignore IDs and external IDs that are not found

required
Array of objects or objects or objects
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
{
  • "ignoreUnknownIds": false,
  • "items": [
    • {
      }
    ]
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to List documents