APIs & SDKs

Post

post
https://api.formant.io/v1/admin/annotations

Create a new annotation. Resource: annotations Authorized roles: operator, device

Body Params

Annotation

string
enum
date-time | null

Internal use only, ignore.

uuid | null

User associated with this annotation.

uuid | null

If you want to create this annotation from an existing annotation template, enter its ID here.

taggedUsers
object | null

A map of tag keys to an array of values

string
string | null

Description of this annotation.

focusedDataPoints
array of objects | null
focusedDataPoints
uuid
date-time
date-time
tags
object
uuid

ID of the organization in which to create this new event.

string | null

External ID of this event.

date-time
required

Start time of the data range relevant to this event.

date-time | null

End time of the data range relevant to this event.

uuid | null

If this custom event is related to another event, you can add the ID of that parent event here.

metadata
object

User-customizable metadata associated with this event in key-value pair format.

string
length ≤ 1024

Message of this event. Must match the message field in the Formant UI when configuring a custom event.

boolean
uuid | null

ID of the device relevant to this event.

string | null
string | null
enum
uuid | null
boolean

Set this to true to enable notifications for this event.

notificationMuted
object | null

Set this to temporarily mute notifications for this event.

date-time | null
Response

Updated 5 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago