Skip to navigation

Permanently delete all or filtered objects

View as Markdown

Permanently deletes the objects of a definition in a space. The objects cannot be restored. The definition stays. Authorization: requires space:contribute on :spaceId. Lacking it gives 403 (no space:read gives 404). Body: { view? }. With view, only the objects that match the filters of that saved view are deleted. One request deletes at most 2000 objects. Returns { deleted, more }. When more is true, send the same request again.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired
definitionIdstringRequired

Request

This endpoint expects an object.
viewstringOptional>=1 character
A saved view id. Only the objects that match its filters are deleted. Without it, all the objects are deleted.

Response

The deleted count.
deleteddouble
How many objects the request deleted.
moreboolean
True when matching objects can stay. Send the same request again.

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error