Update Annotation

Update an item's annotation

Request
path Parameters
annotationId
required
string

Annotation id

query Parameters
system
boolean

when specified - editing system space metadata is enabled

replace
boolean
Request Body schema: application/json

Updated annotation object

creator
required
string
type
required
string (AnnotationType)
Enum: "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text"
label
required
string
coordinates
any
attributes
Array of strings
object (APIMetadata)
property name*
additional property
any
Responses
200

Ok

put/annotations/{annotationId}
Request samples
application/json
{
  • "creator": "string",
  • "type": "class",
  • "label": "string",
  • "coordinates": null,
  • "attributes": [
    ],
  • "metadata": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "url": "string",
  • "type": "class",
  • "label": "string",
  • "attributes": [
    ],
  • "coordinates": {
    },
  • "metadata": {
    },
  • "creator": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "itemId": "string",
  • "item": "string",
  • "datasetId": "string",
  • "dataset": "string",
  • "hash": "string",
  • "labelSuggestions": {
    },
  • "source": "ui",
  • "description": "string",
  • "srcAnnotation": "string"
}