Delete an object from the database

Delete an individual object on the database:

DELETE https://sub-domain.cloudtables.io/api/1/dataset/:id/:row?key=:apiKey

curl \
	-X DELETE \
	https://sub-domain.cloudtables.io/api/1/dataset/:id/:row?key=:apiKey

This call will delete the identified row from a data set, where:

• :apiKey is the API key to use for access (see below)
• :id is the data set id (a UUID), per the /datasets API. The data set ID can also be found in the Data set inspector of the Data tab for the data set.
• :row is the row id (an integer) for the object to get.

Query parameters

• clientId string
  A unique id for the client accessing the table on your system. While this is optional it is a recommended parameter as it is useful for tracking requests in CloudTables' analytics.
• clientName string
  A label that can help identify a user - e.g. a name or e-mail address. Typically the clientId will be an integer or UUID which mean you'd need to look up the user to understand who made what changes. Note that while the clientId should be unique per client and not change - the clientName can change and will be updated to reflect the latest value given (e.g. if a user modifies their name in your own system).
• key string Required Header
  The API key which will allow access (and thus assign the roles that can be used for access). Note that this option can be also be provided as an HTTP header (also with the name key).
• role string
  The name of the role that should be used for access (if assigned to the API key - if the role is not available for the API key no access will be granted). If not provided then all roles available to the API key will be used.
• roles string[]
  Similar to role but allows multiple roles to be specified.

Body parameters

• N/A

Result

The returned JSON contains a success property to indicate the status of the action and possibly an `error property if the request should fail, with a message explaining why it failed.

{
	"success": boolean,  // success indicator
	"error": string      // Error message. Please note that this is only returned if there is an error
}