Skip to main content

DeleteItem

Delete an item (using DisplayID)

Description​

Delete the specified item (ID entered from the Hexabase screen).

Method​

DELETE

Request URL Format​

/api/v0/applications/:app-id/datastores/:datastore-id/items/delete/:item-id

URL Params​

app-id          : Application ID (ID entered from Hexabase screen or internal ID [p_id])
datastore-id    : Data store ID (ID entered from Hexabase screen or internal ID [d_id])
item-id         : ID of the subject item

Payload​

（Attention）

  • Even if no parameters are specified, an empty JSON {} must be specified.
  • If delete_linked_items : true, target_datastores to be deleted must be specified.
  • Display ID or d_id can be specified for target_datastores. It can be specified by following the relationship, e.g., grandchild databases.
  • The maximum number of items associated with an item that this API can delete is 100; if more than 100 items are associated with an item, that item will not be deleted.
{
  delete_linked_items: true,                                     // true : Related items are also deleted
  target_datastores: [ "DATASTORE_A", "DATASTORE_B", ...] // delete_linked_items: If true, specify the display ID (or d_id) of the related data store to be deleted. (This can be specified only within the same application.) Note: If not specified, the item will not be deleted.
}

Request URL Sample​

DELETE http://api.xxx.com/api/v0/applications/APPNAME/datastores/RESERVES/items/delete/5d4c058baa39555618ac9e8b

Payload (Empty JSON must be specified)
{}

Response Sample​

{
    "error": null
}