Annotations

Update annotation

Changed on

Update existing attributes on an annotation.

patch/api/annotations/{id}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/annotations/{id}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

bulk_createdboolean nullable

Annotation was created in bulk mode

completed_byinteger
draft_created_atstring date-time nullable

Draft creation time

ground_truthboolean

This annotation is a Ground Truth (ground_truth)

import_idinteger nullable

Original annotation ID that was at the import step or NULL if this annotation wasn't imported

last_action'prediction' | 'propagated_annotation' | 'imported' | 'submitted' | 'updated' | 'skipped' | 'accepted' | 'rejected' | 'fixed_and_accepted' | 'deleted_review'
  • prediction - Created from prediction
  • propagated_annotation - Created from another annotation
  • imported - Imported
  • submitted - Submitted
  • updated - Updated
  • skipped - Skipped
  • accepted - Accepted
  • rejected - Rejected
  • fixed_and_accepted - Fixed and accepted
  • deleted_review - Deleted review
last_created_byinteger nullable

User who created the last annotation history item

lead_timenumber double nullable

How much time it took to annotate the task

parent_annotationinteger nullable

Points to the parent annotation from which this annotation was created

parent_predictioninteger nullable

Points to the prediction from which this annotation was created

projectinteger nullable

Project ID for this annotation

resultobject[]

List of annotation results for the task

taskinteger nullable

Corresponding task for this annotation

unique_idstring
updated_byinteger nullable

Last user who updated this annotation

was_cancelledboolean

User skipped the task

Response

Updated annotation

bulk_createdboolean nullable

Annotation was created in bulk mode

completed_byinteger
created_agostring required

Time delta from creation time

created_atstring date-time required

Creation time

created_usernamestring required

Username string

draft_created_atstring date-time nullable

Draft creation time

ground_truthboolean

This annotation is a Ground Truth (ground_truth)

idinteger required
import_idinteger nullable

Original annotation ID that was at the import step or NULL if this annotation wasn't imported

last_action'prediction' | 'propagated_annotation' | 'imported' | 'submitted' | 'updated' | 'skipped' | 'accepted' | 'rejected' | 'fixed_and_accepted' | 'deleted_review'
  • prediction - Created from prediction
  • propagated_annotation - Created from another annotation
  • imported - Imported
  • submitted - Submitted
  • updated - Updated
  • skipped - Skipped
  • accepted - Accepted
  • rejected - Rejected
  • fixed_and_accepted - Fixed and accepted
  • deleted_review - Deleted review
last_created_byinteger nullable

User who created the last annotation history item

lead_timenumber double nullable

How much time it took to annotate the task

parent_annotationinteger nullable

Points to the parent annotation from which this annotation was created

parent_predictioninteger nullable

Points to the prediction from which this annotation was created

projectinteger nullable

Project ID for this annotation

resultobject[]

List of annotation results for the task

statestring required
taskinteger nullable

Corresponding task for this annotation

updated_atstring date-time required

Last updated time

updated_byinteger nullable

Last user who updated this annotation

was_cancelledboolean

User skipped the task

Changes

  • e1ba2ecdbabbRevision changes
    • breaking

      the request property format changed from no format to double

    • 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 media type application/x-www-form-urlencoded to the request body

    • info

      added the media type multipart/form-data to the request body

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

  • 04ff286141b5Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status