Sign in
Annotation

Start edit pages session

Starts editing the annotation and all its child documents (the documents into which the original document was split). The parent annotation must be in the to_review, split or reviewing state (for the calling user). This call will "lock" the parent and child annotations from being edited.

It returns some basic information about the parent annotation and a list of its children. Children to which the current user does not have rights contains only limited information.

If the parent annotation cannot be "locked", an error is returned. If the child annotation cannot be locked, it is skipped and sent in a response with value started=False.

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

Path parameters

annotationIDinteger required

Annotation ID

Response

Edit pages session started successfully

parent_annotationstring uri

URL of the parent annotation

session_timeoutstring

Session timeout duration format "HH:MM:SS"

Example response

{
  "parent_annotation": "https://example.rossum.app/api/v1/annotations/12345",
  "children": [
    {
      "parent_pages": [
        {
          "page": "https://example.rossum.app/api/v1/pages/12345",
          "rotation_deg": 90
        }
      ],
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "status": "to_review",
      "url": "https://example.rossum.app/api/v1/annotations/67890",
      "original_file_name": "large_document.pdf"
    }
  ],
  "session_timeout": "01:00:00"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.