POST

Remove Data Items


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Removes one or more items from a collection. The response object must contain the removed item.

Endpoint
POST
{DEPLOYMENT-URI}/v3/items/remove
Body Params
collectionIdstringRequired

ID of the collection from which to remove items.


itemIdsArray <string>RequiredminItems 1

IDs of items to remove.

Response Object
resultsArray <DataItemModificationResult>

Response must include either the removed item or an error.

Request
cURL
curl POST https://external-db.example.com/v3/items/remove \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' \ --d '{ "collectionId": "cities", "itemIds": ["c285e77c-a86b-4361-a55f-c6b934d70187"] }'
Response
JSON
{ "results": [ { "item": { "name": "New York", "_id": "c285e77c-a86b-4361-a55f-c6b934d70187", "_owner": "facda016-24ef-4909-a90e-70687f17f658", "_createdDate": { "$date": "2021-01-02T03:04:05Z" }, "_updatedDate": { "$date": "2021-04-05T06:07:08Z" } } } ] }
Did this help?