How to bulk delete content using API?

This document will define steps to delete the contents of a schema by using the API directly. Postman application is used here to trigger the API endpoint.

Please frame the endpoint to hit the delete action.

Endpoint URL: {{domainURL}}/api/schema/{{schema_keyValue}}/data?projectId={{projectID}}

Sample endpoint: https://example.orbita-eng.cloud:8443/api/schema/sampleschema/data?projectId=628e1ced1fc9c700730133d4

The schema key value can be viewed on the Schema page

Postman application steps

Use the Postman application for hitting the endpoint. Please refer to the following parameters that you will need.

Parameter	Value

Parameter	Value
Method	`DELETE`
Headers	`KEY: Content-Type` `Value: application/json`
Headers	`KEY: Authorization` `Value: {{Insert the Bearer token from the user login}}`
Body	The `filter` object can be used to filter the data to perform the delete action. 1. To select all documents in the collection, pass an empty document as the query filter parameter `{ "filter": {} }` 2. The following example selects from the dynamic data collection all documents where the `hospitalName`equals `"Valley Hospitals"` `{ "filter": {"hospitalName": "Valley Hospitals"} }` 3. The following example selects all documents from the dynamic data collection where `hospitalName` equals either `"Valley Hospitals"` or `"Valley Clinic"` `{ "filter": {"hospitalName": {$in:["Valley Hospitals","Valley Clinic"]}} }` 4. The following example selects all documents in the dynamic data collection where the `hospitanName` equals `"Valley Hospitals"` and `rating` is less than (`$lt`) `3` 5. The following example selects all documents in the dynamic data collection where the `hospitalName` equals `"Valley Hospitals"` or `rating` is less than (`$lt`) `3` 6. In the following example, the compound query document selects all documents in the dynamic data collection where the `hospitalName` equals `"Valley Hospitals"` and either `rating` is less than (`$lt`) `3` or `location` starts with the character `p`:

Endpoint set with the Headers

Sample Response

After the delete action is done, the response will have the object nRemoved populated with the count of records that were deleted.