Delete Document¶
Deletes a document from the Solr index.
Resource Information¶
This service uses the tomcat application on port 8080 by default. To see a list of default ports click here
The context for this API is /crafter-search, please prefix the API URLs with this context.
HTTP Verb
|
POST
|
URL
|
/api/2/search/delete |
Response Formats
|
JSON |
Parameters¶
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
index_id
|
String
|
The index ID
|
|
site
|
String
|
✓
|
The site name
|
id
|
String
|
✓
|
The document ID
|
token
|
String
|
✓
|
The access token.
|
The access token could be optional depending on the configuration.
Example¶
Request¶
POST .../api/2/search/delete?token=myAccessToken
index_id=editorial
site=editorial
id=/site/website/articles/2017/women-styles-for-winter/index.xml
Response¶
Status 200 OK
{
"message": "OK"
}
Responses¶
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
.../api/2/search/delete |
See example above.
|
500
|
{ "message" : "Internal server error" } |
|
503
|
{ "message" : "Service unavailable, please try again later" } |