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
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.
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
automatically_rejectedboolean required
Indicates whether the annotation was rejected automatically.
predictionobject nullable required
Internal prediction data including engine version info.
assigneesstring[] required
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.