ROrossum
Annotation

Edit pages (split and reorganize)

Changed on

Edit document pages, split and re-split already split document.

Can be called on an annotation in importing, to_review, reviewing or confirmed status.

When using this endpoint, status of the original annotation (when not editing existing split) is switched to split, status of the newly created annotations is importing and the extraction phase begins over again.

This endpoint can be used for splitting annotations also from webhook listening to annotation_content.initialize event and action.

Operations:

  • edit: Create new annotations from parent pages with optional rotation and values
  • move: Move existing child annotations — or the annotation itself — to different queues
  • delete: Delete child annotations — or the annotation itself
  • stop_reviewing: Stop review on child annotations without deleting

When move or delete targets the annotation itself, no other operations (edit, additional move/delete entries) are allowed in the same request.

post/api/v1/annotations/{annotationID}/edit_pages

Request

Path parameters

annotationIDinteger required

Annotation ID

Request body

deletestring[]

Annotations to delete. May contain child annotations, or the annotation itself (in that case, no other operations are allowed in the request).

stop_reviewingstring[]

Child annotations to stop reviewing. Must be in reviewing or confirmed state.

stop_parentboolean

Whether to stop reviewing the parent annotation

Example request

{
  "edit": [
    {
      "parent_pages": [
        {
          "page": "https://example.rossum.app/api/v1/pages/12345",
          "rotation_deg": 90
        }
      ],
      "target_queue": "https://example.rossum.app/api/v1/queues/111",
      "metadata": {
        "annotation": {
          "some_key": "some value"
        }
      },
      "document_name": "my_document.pdf",
      "annotation": "https://example.rossum.app/api/v1/annotations/42"
    }
  ],
  "move": [
    {
      "annotation": "https://example.rossum.app/api/v1/annotations/67890",
      "target_queue": "https://example.rossum.app/api/v1/queues/111"
    }
  ],
  "delete": [
    "https://example.rossum.app/api/v1/annotations/67890"
  ],
  "stop_reviewing": [
    "https://example.rossum.app/api/v1/annotations/67891"
  ],
  "stop_parent": true
}

Response

Edit pages operation completed successfully

Example response

{
  "results": [
    {
      "annotation": "https://example.rossum.app/api/v1/annotations/67890",
      "document": "https://example.rossum.app/api/v1/documents/456700"
    }
  ]
}

Changes