Delete a dataset item

client.datasetItems.archive(, ?): DatasetItemArchiveResponse { id, deleted, object }

DELETE/v5/dataset-items/{dataset_item_id}

Soft-delete a dataset item by marking it as removed in the current dataset version.

The database row is not removed; instead the item’s end version is set to the current dataset version so it no longer appears at the latest version while remaining retrievable at earlier versions, and a new dataset version snapshot is created to record the removal. An item that is already archived or already deleted cannot be deleted again. The response echoes the item id with deleted set to true.

ParametersExpand Collapse

datasetItemID: string

ReturnsExpand Collapse

DatasetItemArchiveResponse { id, deleted, object }

id: string

deleted: boolean

object?: "dataset.item"

Delete a dataset item

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const response = await client.datasetItems.archive('dataset_item_id');

console.log(response.id);

{
  "id": "id",
  "deleted": true,
  "object": "dataset.item"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "dataset.item"
}