v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB

Scheduling

Delete Machine Tasks

Deletes scheduled tasks for machines based on the provided query parameters such as SchedulingIds, MachineID, and date.

delete/v1/Scheduling/schedule/machine-tasks

Query parameters

SchedulingIdsinteger[]

A list of unique identifiers for the specific scheduling instances to be deleted.

MachineIDinteger

The unique identifier of the machine for which the tasks are to be deleted.

isStaticboolean

A flag indicating if the tasks are static.

datestring

The date for which the tasks are to be deleted.

Response

The details of the deleted tasks.

MachineIdinteger

The unique identifier of the machine associated with the task.

TaskLutIdstring nullable

The identifier for the type of task from the lookup table.

SchedulingIdinteger

The unique identifier of the scheduling instance.

DriverIdstring uuid nullable

The unique identifier of the driver assigned to the task.

DriverNamestring nullable

The name of the driver assigned to the task.

TimezoneOffsetnumber double

The timezone offset in hours for the scheduled task.

ScheduleDatestring date-time nullable

The date and time when the task is scheduled.

StatusIdinteger

The status identifier of the task.

Notesstring nullable

Additional notes related to the task.

GeneratePickListboolean

Indicates whether a pick list should be generated for the task.

GeneratePickListTimestring nullable

The time when the pick list is generated.

GeneratePickListRangeinteger nullable

The range in minutes for generating the pick list.

ScheduleNextWorkingDayboolean

Indicates whether the task should be scheduled for the next working day.

AssignedToPatternIdinteger nullable

The unique identifier of the pattern to which the task is assigned.

AssignedToScheduleIdinteger nullable

The unique identifier of the schedule to which the task is assigned.

IncompletionReasonstring nullable

The reason for task incompletion, if applicable.

IsClusteredboolean nullable

Indicates whether the task is part of a clustered set of tasks.

ClusterIdsstring nullable

The identifiers of the clustered tasks, if applicable.

CreatedByinteger

The unique identifier of the user who created the task.

CreatedDtstring date-time

The date and time when the task was created.

UpdatedByinteger nullable

The unique identifier of the user who last updated the task.

UpdatedDtstring date-time nullable

The date and time when the task was last updated.

isMobileboolean nullable

Indicates whether the task was created or updated via a mobile device.

isSeriesUpdateboolean nullable

Indicates whether the task is part of a series update.

originalDatestring nullable

The original date of the task before any rescheduling, if applicable.

IncompletionReasonIdinteger nullable

The unique identifier of the reason for task incompletion.

IncompletionReasonNamestring nullable

The name of the reason for task incompletion.