Delete All Documents
This API is used to delete all indexed files from the database based on the API parameter.
API URL
The Delete All Documents API uses the below URL:
https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/deleteAllDocs
Note: Based on the deleteAllDocument parameter in the API
request, the indexed documents are deleted, for more details, refer below API parameter
section.
API Endpoint
The Delete All Documents API uses the below endpoint:/deleteAllDocs
API Method
The Delete All Documents API uses only POST method.API Request Type
The Delete All Documents API uses JSON request type.API Request Headers
Header | Data Type | Description |
---|---|---|
Content-Type | string | Indicates the input type of the incoming request body. The
only supported value is
application/json . |
API Parameters
To execute Delete All Documents API, the following parameters in the JSON request are
needed:
Name | Type | Description | Remarks |
---|---|---|---|
indexType | String | Type of the file i.e Resume or JD | Required |
indexKey | String | Use your user key as shared by RChilli team | Required |
subUserId | String | Your user's unique_ID Note: Make sure
that there is no space in your subuser_id |
Optional |
deleteAllDocument | Boolean |
|
Optional |
JSON Request For Delete All Documents
{
"index": {
"indexType": "{{Resume or JD}}",
"indexKey": "{{IndexKey}}"
},
"deleteAllDocument": true
}
JSON Response For Delete All Documents - Resume
{
"status": "200",
"indexType": "Resume",
"output": "indexes deleted successfully"
}
Error Code
Error Code | Error Message |
---|---|
2117 | deleteAllDocument parameter value must have either true or false |