Skip to content

Create/Update annotation

Request

Update an annotation if it exists, create a new one otherwise.

Security
api_key
Bodyapplication/jsonrequired

The configuration for an annotation to store.

cameraPositionIdstring, (uuid)required
idstring or null, (uuid)
kindstring
Enum:"polygon""multipolygon"
roiobject or nullrequired
statestring
Enum:"active""deleted"
curl -i -X PUT \
  https://coreapi.hoxton.ai/_mock/v1/annotations \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "kind": "polygon",
    "roi": {},
    "state": "active"
  }'

Responses

OK.

Bodyapplication/json
cameraPositionIdstring, (uuid)required
createdAtstring, (date-time)read-only
deletedAtstring or null, (date-time)read-only
idstring or null, (uuid)
kindstring
Enum:"polygon""multipolygon"
roiobject or nullrequired
statestring
Enum:"active""deleted"
Response
{
  "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  "createdAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "kind": "polygon",
  "roi": {},
  "state": "active"
}