APIs & SDKs

Post

post
https://api.formant.io/v1/admin/task-summaries/

Create a new task summary. Before you can create a task summary, you must first create a task summary format. Resource: taskSummaries Authorized roles: operator, device

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

TaskSummary

string
enum

Enter task-summary.

uuid
required

ID of the task summary format which describes this task summary.

report
object
required

Enter the data for this task summary in key-value pairs, as described by the task summary format.

date-time | null

End time of the data range relevant to this event.

string
required

Enter a unique identifier to identify this task summary.

date-time
required

Enter a start time for when this event occurred. This differs from createdAt, which is automatically populated when the task summary is created.

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.

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 7 months ago

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

Updated 7 months ago