APIs & SDKs

Post

post
https://api.formant.io/v1/admin/intervention-requests

Create a new intervention request. Resource: interventions Authorized roles: administrator, device

Body Params

InterventionRequest

string
enum

Enter intervention-request.

string
enum

selection prompts user to select an option from a dropdown menu. labeling prompts user to draw a box around and object and give it a label.

Allowed:
data
required
responses
array
responses
uuid

ID of the device which prompts this intervention request.

string
enum

Severity of this event (info, warning, error, or critical).

Allowed:
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.

uuid | null

User ID associated with 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