ROrossum
Annotation

Create annotation

Changed on

Create an annotation object.

Normally you create annotations via the upload endpoint.

This endpoint could be used for creating annotation instances including their content and with status set to an explicitly requested value. Currently only created is supported which is not touched by the rest of the platform and is not visible via the Rossum UI. This allows for subsequent updates before switching the status to importing so that it is passed through the rest of the upload pipeline.

The use-case for this is the upload.created hook event where new annotations could be created and the platform runtime then switches all such annotations' status to importing.

post/api/v1/annotations

Request

Request body

idinteger

ID of the annotation.

urlstring uri

URL of the annotation.

status'confirmed' | 'created' | 'deleted' | 'exported' | 'exporting' | 'failed_export' | 'failed_import' | 'importing' | 'in_workflow' | 'postponed' | 'purged' | 'rejected' | 'reviewing' | 'split' | 'to_review'

Status of the document, see Annotation Lifecycle for more details.

documentstring uri

Related document.

queuestring uri

A queue that annotation belongs to.

schemastring uri

A schema that defines content shape.

relationsstring[]

List of relations that annotation belongs to.

pagesstring[]

List of rendered pages.

creatorstring uri nullable

User that created the object.

created_atstring date-time

Timestamp of object's creation.

modifierstring uri nullable

User that last modified the annotation.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

assigned_atstring date-time nullable

Timestamp of last assignment to a user or when the annotation was started being annotated.

confirmed_atstring date-time nullable

Timestamp when the annotation was moved to status confirmed.

deleted_atstring date-time nullable

Timestamp when the annotation was moved to status deleted.

exported_atstring date-time nullable

Timestamp of finished export.

export_failed_atstring date-time nullable

Timestamp of failed export.

purged_atstring date-time nullable

Timestamp when was annotation purged.

rejected_atstring date-time nullable

Timestamp when the annotation was moved to status rejected.

confirmed_bystring uri nullable

User that confirmed the annotation.

deleted_bystring uri nullable

User that deleted the annotation.

exported_bystring uri nullable

User that exported the annotation.

purged_bystring uri nullable

User that purged the annotation.

rejected_bystring uri nullable

User that rejected the annotation.

rir_poll_idstring nullable

Internal identifier used by Rossum.

contentstring uri

Link to annotation content (datapoint values), see Annotation Content.

suggested_editstring uri nullable

Link to Suggested edit object.

time_spentnumber float

Total time spent while validating the annotation.

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

automatedboolean

Whether annotation was automated

related_emailsstring[]

List of emails related with annotation.

emailstring uri nullable

Related email that the annotation was imported by (for annotations imported by email).

automation_blockerstring uri nullable

Related automation blocker object.

email_threadstring uri nullable

Related email thread object.

has_email_thread_with_repliesboolean

Related email thread contains more than one incoming email.

has_email_thread_with_new_repliesboolean

Related email thread contains an unread incoming email.

organizationstring uri

Organization URL.

automatically_rejectedboolean

Indicates whether the annotation was rejected automatically.

predictionobject nullable

Internal prediction data including engine version info.

assigneesstring[]

List of assigned users.

labelsstring[]

List of selected labels.

restricted_accessboolean

Access to annotation is restricted.

training_enabledboolean

Flag signalling whether the annotation should be used in the training of the instant learning component.

Example request

{
  "id": 314528,
  "url": "https://example.rossum.app/api/v1/annotations/314159",
  "status": "to_review",
  "document": "https://example.rossum.app/api/v1/documents/456700",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "schema": "https://example.rossum.app/api/v1/schemas/31336",
  "relations": [],
  "pages": [
    "https://example.rossum.app/api/v1/pages/558598"
  ],
  "creator": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z",
  "rir_poll_id": "54f6b9ecfa751789f71ddf12",
  "content": "https://example.rossum.app/api/v1/annotations/314159",
  "metadata": {
    "some_key": "some_value"
  },
  "related_emails": [],
  "email": "https://example.rossum.app/api/v1/emails/1234",
  "email_thread": "https://example.rossum.app/api/v1/email_threads/456",
  "has_email_thread_with_replies": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "assignees": [
    "https://example.rossum.app/api/v1/users/1",
    "https://example.rossum.app/api/v1/users/2"
  ],
  "labels": [],
  "training_enabled": true
}

Response

Created

idinteger required

ID of the annotation.

urlstring uri required

URL of the annotation.

status'confirmed' | 'created' | 'deleted' | 'exported' | 'exporting' | 'failed_export' | 'failed_import' | 'importing' | 'in_workflow' | 'postponed' | 'purged' | 'rejected' | 'reviewing' | 'split' | 'to_review' required

Status of the document, see Annotation Lifecycle for more details.

documentstring uri required

Related document.

queuestring uri required

A queue that annotation belongs to.

schemastring uri required

A schema that defines content shape.

relationsstring[] required

List of relations that annotation belongs to.

pagesstring[] required

List of rendered pages.

creatorstring uri nullable required

User that created the object.

created_atstring date-time required

Timestamp of object's creation.

modifierstring uri nullable required

User that last modified the annotation.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

assigned_atstring date-time nullable required

Timestamp of last assignment to a user or when the annotation was started being annotated.

confirmed_atstring date-time nullable required

Timestamp when the annotation was moved to status confirmed.

deleted_atstring date-time nullable required

Timestamp when the annotation was moved to status deleted.

exported_atstring date-time nullable required

Timestamp of finished export.

export_failed_atstring date-time nullable required

Timestamp of failed export.

purged_atstring date-time nullable required

Timestamp when was annotation purged.

rejected_atstring date-time nullable required

Timestamp when the annotation was moved to status rejected.

confirmed_bystring uri nullable required

User that confirmed the annotation.

deleted_bystring uri nullable required

User that deleted the annotation.

exported_bystring uri nullable required

User that exported the annotation.

purged_bystring uri nullable required

User that purged the annotation.

rejected_bystring uri nullable required

User that rejected the annotation.

rir_poll_idstring nullable required

Internal identifier used by Rossum.

contentstring uri required

Link to annotation content (datapoint values), see Annotation Content.

suggested_editstring uri nullable required

Link to Suggested edit object.

time_spentnumber float required

Total time spent while validating the annotation.

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

automatedboolean required

Whether annotation was automated

related_emailsstring[] required

List of emails related with annotation.

emailstring uri nullable required

Related email that the annotation was imported by (for annotations imported by email).

automation_blockerstring uri nullable required

Related automation blocker object.

email_threadstring uri nullable required

Related email thread object.

has_email_thread_with_repliesboolean

Related email thread contains more than one incoming email.

has_email_thread_with_new_repliesboolean

Related email thread contains an unread incoming email.

organizationstring uri required

Organization URL.

automatically_rejectedboolean required

Indicates whether the annotation was rejected automatically.

predictionobject nullable required

Internal prediction data including engine version info.

assigneesstring[] required

List of assigned users.

labelsstring[] required

List of selected labels.

restricted_accessboolean required

Access to annotation is restricted.

training_enabledboolean required

Flag signalling whether the annotation should be used in the training of the instant learning component.

Example response

{
  "id": 314528,
  "url": "https://example.rossum.app/api/v1/annotations/314159",
  "status": "to_review",
  "document": "https://example.rossum.app/api/v1/documents/456700",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "schema": "https://example.rossum.app/api/v1/schemas/31336",
  "relations": [],
  "pages": [
    "https://example.rossum.app/api/v1/pages/558598"
  ],
  "creator": "https://example.rossum.app/api/v1/users/10775",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z",
  "rir_poll_id": "54f6b9ecfa751789f71ddf12",
  "content": "https://example.rossum.app/api/v1/annotations/314159",
  "metadata": {
    "some_key": "some_value"
  },
  "related_emails": [],
  "email": "https://example.rossum.app/api/v1/emails/1234",
  "email_thread": "https://example.rossum.app/api/v1/email_threads/456",
  "has_email_thread_with_replies": true,
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "assignees": [
    "https://example.rossum.app/api/v1/users/1",
    "https://example.rossum.app/api/v1/users/2"
  ],
  "labels": [],
  "training_enabled": true
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      added subschema #2 to the request property allOf list

    • breaking

      the request property type changed from string to no type, and format from uri to no format

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new confirmed enum value to the request property

    • info

      added the new deleted enum value to the request property

    • info

      added the new exported enum value to the request property

    • info

      added the new exporting enum value to the request property

    • info

      added the new failed_export enum value to the request property

    • info

      added the new failed_import enum value to the request property

    • info

      added the new importing enum value to the request property

    • info

      added the new in_workflow enum value to the request property

    • info

      added the new postponed enum value to the request property

    • info

      added the new purged enum value to the request property

    • info

      added the new rejected enum value to the request property

    • info

      added the new reviewing enum value to the request property

    • info

      added the new split enum value to the request property

    • info

      added the new to_review enum value to the request property

    • info

      added subschema #2 to the response body allOf list for the response status