schema

Cancel the in-flight reindex task on a property's inverted index

Cancels the in-flight reindex task targeting this property's index. No request body. Idempotent: succeeds whether or not a task was in flight (a 202 with {"status":"NO_OP"} is returned when there is nothing to cancel). A task that is in flight but no longer cancellable is refused with 409. indexName accepts rangeable as an alias for rangeFilters.

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

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/properties/{propertyName}/index/{indexName}/cancel
  • 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 reindex task should be cancelled.

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

The inverted index type whose in-flight task should be cancelled. rangeable is accepted as a write-path alias for rangeFilters.

Response

Cancellation processed. Body carries {"status":"CANCELLED","taskId":...} when a STARTED task was cancelled, or {"status":"NO_OP"} when there was nothing to cancel.

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.