Developer Guide

DeleteData-Async

delete
https://api.dengage.com/rest/dataspace/async/delete

DeleteData-Async

There are two versions of DeleteData API calls. This particular version is the asynchronous version where large amounts of data (more than 1000 records) are subject to be deleted from a selected data table.

DeleteData-Async works by uploading a file with the records to be deleted. When deleting data, primary key columns are required. If the target table has primary key values, the request must include these primary key values for deletion to work.

The data in master_contact, master_device and system tables cannot be deleted.

The asynchronous version returns the uuid of the delete job that was started. The status and the result of the ongoing DeleteData jobs must be queried with the GetStatus API call using the returned jobId.

Body Params

tableId OR tableName is required along with columnMapping and fileContent. All primary key columns of the table must be included in the columnMapping.

columnMapping
array of objects

Mapping between the table columns and the columns in the file header. The file header columns must be separated with either ; or ,. Each mapping must include the table column name and corresponding file column header.

columnMapping
string

The base64 encoded content of the complete file. The first line of the file must include headers separated by ; or ,

tableColumn and fileColumnHeader are the fields that map table column and the column in the file together.

string

This is an optional field. It names the async delete job. If not provided, a default name with timestamp will be used.

string

The uuid of the table. Either tableId or tableName is required.

string

The name of the table. Either tableId or tableName is required.

Headers
string
required
Defaults to {$$.env.access_token}
Responses

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago