API Reference

Create new task schedule

post
https://api.iotgps.io/v1/tasks/schedule

Creates a new task schedule.

A task schedule is the base set of rules that generates device tasks.
A task schedule determines whether a task needs to be created and the criteria a task needs to follow to know when is due.

For repeating usage-based schedules, every device carries the starting value matching the
schedule's repeat type: startingActiveHours when the schedule repeats by intervalActiveHours,
startingOdometer when it repeats by intervalOdometer. Date-based and one-time schedules take
imei-only entries. Each device's first task is anchored to its own starting value.

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

Parameters to create a task schedule

taskSchedule
object
devices
array of objects

The devices to associate with the task schedule, each with per-device starting
values for repeating usage-based schedules. The starting value matching the
schedule's repeat type is required for every device: startingActiveHours when the
schedule repeats by intervalActiveHours, startingOdometer when it repeats by
intervalOdometer. Date-based and one-time schedules take neither. A per-device
starting value takes precedence over the schedule-level intervalStartingOdometer /
intervalStartingActiveHours for that device's first task. On updates, omitting the
field keeps the device's stored value; an explicit null clears it.

devices
Responses

Updated 3 months ago

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

Updated 3 months ago