Delete a dataset item

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.

Path ParametersExpand Collapse

dataset_item_id: string

ReturnsExpand Collapse

id: string

deleted: boolean

object: optional "dataset.item"

Delete a dataset item

curl https://api.egp.scale.com/v5/dataset-items/$DATASET_ITEM_ID \
    -X DELETE \
    -H "x-api-key: $SGP_API_KEY"

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

Returns Examples

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