Annotation

Start validation

Start reviewing annotation by the calling user. Can be called with statuses payload to specify allowed statuses for starting annotation. Returns 409 Conflict if annotation fails to be in one of the specified states.

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

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/annotations/:annotationID/start/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

statusesstring[]

List of allowed states for the starting annotation to be in.

Response

annotationstring uri

URL of annotation.

session_timeoutstring

Session timeout in format HH:MM:SS.

Example response

{
  "annotation": "https://example.rossum.app/api/v1/annotations/12345",
  "session_timeout": "01:00:00"
}

Changes

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