v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Scheduling

Get Machine Tasks

Retrieves a list of scheduled machine tasks based on various query parameters such as date range, machine, driver, route, and other filters.

get/v1/Scheduling/schedule/machine-tasks

Query parameters

StartDatestring date-time

The start date of the task scheduling period.

EndDatestring date-time

The end date of the task scheduling period.

SchedulingIdinteger

The unique identifier for the specific scheduling instance.

ActorIdinteger

The unique identifier for the actor associated with the task.

MachineIdinteger

The unique identifier for the machine associated with the task.

DriverIdstring uuid

The unique identifier for the driver assigned to the task.

RouteIdinteger

The unique identifier for the route associated with the task.

TimePeriodinteger

The time period for which the tasks are requested, with a default of 31 days.

IsForlistboolean

A flag indicating if the tasks are for list view. Default is true.

IsStaticboolean

A flag indicating if the tasks are static.

Response

A list of scheduled machine tasks matching the specified criteria.

MachineIdinteger

The unique identifier of the machine associated with the task.

RouteIdinteger nullable

The unique identifier of the route associated with the task, if applicable.

RouteNamestring nullable

The name of the route associated with the task, if applicable.

VisitDatestring date-time nullable

The date and time of the scheduled visit.