Yes, Delete API is used to delete indexed files, from the database, by providing document ID.
API URL
The Delete API uses the below URL:
https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/delete
API Endpoint
The Delete API uses the below endpoint:/delete
API Method
The Delete API uses only POST method.API Request Type
The Delete 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 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 |
id | StringArray | List of document ID's you want to delete from the indexed database | Required |
JSON Request For Delete - Resume
{
"index": {
"indexType": "Resume",
"indexKey": "Your user key",
"subUserId": "Your user's unique id"
},
"query": {
"id": [
"1911200457461146","1911200524341134"
]
}
}
JSON Response For Delete - Resume
{
"status": "200",
"indexType": "Resume",
"output": "indexes deleted successfully"
}
JSON Request For Delete - JD
{
"index": {
"indexType": "JD",
"indexKey": "Your user key",
"subUserId": "Your user's unique id"
},
"query": {
"id": [
"1911200457461147","1911200524341135"
]
}
}
JSON Response For Delete - JD
{
"status": "200",
"indexType": "JD",
"output": "indexes deleted successfully"
}
Comments
0 comments
Please sign in to leave a comment.