ROrossum
Annotation

Purge deleted annotations

Start the asynchronous process of purging customer's data related to selected annotations with deleted status. The following operations will happen:

  • delete annotation content
  • delete pages
  • remove content and file names of documents
  • remove annotations from relations of type duplicate
  • preserve annotations objects, move them to purged status

This is an asynchronous endpoint, status of annotations is changed to purged and related objects are gradually being deleted.

At least one of annotations, queue fields must be filled in. The resulting set of annotations is the disjunction of queue and annotations filter.

post/api/v1/annotations/purge_deleted

Request

Request body

annotationsstring[]

List of annotations to be purged.

queuestring uri

Queue of which the annotations should be purged.

Example request

{
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/12345"
  ],
  "queue": "https://example.rossum.app/api/v1/queues/42"
}

Response

Accepted

Changes

No recorded changes to this operation across all 14 revisions of this API.