Patch

patch

https://api.formant.io/v1/admin/schedules/{id}

Update an existing command schedule.
Resource: schedules
Authorized roles: administrator

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

PartialSchedule

organizationId

uuid

ID of the organization to which you want to add this new schedule.

name

string

length ≤ 50

Name of this schedule.

description

string

length ≤ 500

User-friendly description of this command schedule.

type

string

enum

Enter command.

Allowed:

date-time | null

Timestamp at which this command should execute. Must be in the future. Format: YYYY-MM-DDTHH:MM:SS

cron

string | null

Frequency of this command schedule, as defined at https://crontab.guru

durationMs

int64

0 to 9007199254740991

Enter 0 for this parameter.

timezone

string

Timezone which corresponds to the timestamp provided in the at parameter, in tz database format.

displayTimezone

string

commandTemplateId

uuid | null

You must create a command template before you can schedule this command.

composeOperationId

uuid | null

Runs theopolis task source.

workflowId

string | null

parameterValue

string | null

Value of the command parameter to be sent with this scheduled command.

deviceId

uuid

ID of the device to which to send this command.

status

string

length ≤ 1000

Internal use only, ignore.

theopolis

object | null

taskFlowConfiguration

object | null

uuid

createdAt

date-time

updatedAt

date-time

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200