schema

Rebuild a property's inverted index with unchanged configuration

Rebuilds the inverted index from the stored objects with its current configuration (repair / format refresh). No request body. Index-mutating work is asynchronous: a 202 with a task ID is returned. indexName accepts rangeable as an alias for rangeFilters.

post/schema/{className}/properties/{propertyName}/index/{indexName}/rebuild

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/properties/{propertyName}/index/{indexName}/rebuild
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

classNamestring required

The name of the collection (class) containing the property.

propertyNamestring required

The name of the property whose inverted index should be rebuilt.

indexName'filterable' | 'searchable' | 'rangeFilters' | 'rangeable' required

The inverted index type to rebuild. rangeable is accepted as a write-path alias for rangeFilters.

Query parameters

tenantsstring[]

Tenant names to target. Allowed for all index types on multi-tenant collections (rebuilds are format-only). Omit to target all tenants.

Response

Reindex task submitted.

taskIdstring
statusstring

What the server did. STARTED: a reindex task was submitted and taskId names it. CANCELLED: a cancel stopped the in-flight task named by taskId. NO_OP: a cancel found nothing in flight, and taskId is absent. Not a closed set: a newer server may answer with a value this client does not know, so report an unrecognized status rather than rejecting the response.

Changes

No recorded changes to this operation across all 1 revision of this API.