Add the drop index request

Contributors

DELETE /persistence/v1/service/{serviceName}/collection/{collectionName}/index/{indexName}

Adds the drop index request that will be used to delete the index. The POST index execute API call deletes the indexes that have been scheduled by using this API call.

Parameters

Name Type In Required Description

serviceName

string

path

True

Participating external service name (name of the database).

collectionName

string

path

True

Persistence service collection name (name of the table).

indexName

string

path

True

Name of index to be deleted.

X-Service-Request-Id

string

header

False

Request identifier used to tag the request for better supportability.

Response

Status: 200, Success response
Name Type Required Description

documentId

string

False

Response

Status: 4xx, Default response
Name Type Required Description

errorCode

string

False

Error code

error

string

False

Error category

message

string

False

Error description message

Example response

{
  "errorCode": "P1002",
  "error": "api error",
  "message": "No document found of the specified documentId"
}