Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
index

Returns the status of the delete request

Returns the details of the specified delete request. Delete request can be in one of the following states: Scheduled, Processing, Failed, Succeeded. See Data API Developer’s Guide in the Documentation section for the delete request state diagram.

get/layers/{layerID}/deleteRequest/{deleteId}

Path parameters

layerIDstring required

The ID of the index layer you want to get the delete request status for.

deleteIdstring required

Id of the delete request returned from the index delete operation.

Response

Delete request status

deleteIdstring [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
state'Scheduled' | 'Processing' | 'Failed' | 'Succeeded'

The state of the delete request.

  • Scheduled - The delete request was successfully scheduled.
  • Processing - The delete request is being executed.
  • Failed - The delete request failed. Please try again.
  • Succeeded - The delete request finished successfully. The number of deleted records is provided in the count field.
messagestring

A message describing the state.

countinteger

Number of deleted index records.

Example response

{
  "deleteId": "e07191de-8ab8-49f5-a11d-8240e1b93ab7",
  "state": "Failed",
  "message": "Delete request failed due to ...."
}