HoxtonAi
Powered by Redocly

Annotations

APIs to manage an annotation.

Create/Update annotation

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

Securityo_auth
Request
Request Body schema: application/json
required

The configuration for an annotation to store.

cameraPositionId
required
string <uuid>
id
string or null <uuid>
kind
string
Enum: "polygon" "multipolygon"
roi
required
object or null
state
string
Enum: "active" "deleted"
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

put/annotations
Request samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "kind": "polygon",
  • "roi": { },
  • "state": "active"
}
Response samples
application/json
{
  • "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"
}

Delete annotation

Delete an annotation.

Securityo_auth
Request
path Parameters
annotationId
required
string <uuid>

The ID of the annotation to be deleted.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

delete/annotations/{annotationId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get annotation
Get an annotation identified by its id.


Securityo_auth 
Request 
path Parameters
annotationId
required
string <uuid> 
The ID of the annotation to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/annotations/{annotationId}
Request samples 
Response samples 
application/json
{
  • "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"
}
List annotation
Get all available annotations subject to filters.


Securityo_auth 
Request 
query Parameters
cameraPositionId
string <uuid> 
The ID of a camera position linked to the annotations.


 
organisationId
string <uuid> 
The ID of the associated organisation.


 
siteId
string <uuid> 
The ID of the associated site.


 
state
string
annotation state.


 Enum: "active" "deleted"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/annotations
Request samples 
Response samples 
application/json
[
  • {
    }
]