v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Scheduling

Create Machine Tasks

Creates new scheduled tasks for machines. The request body should include details of the tasks to be scheduled.

post/v1/Scheduling/schedule/machine-tasks

Request body

MachineIdinteger

The unique identifier of the machine for which the task is being scheduled.

TaskLutIdstring nullable

The identifier for the type of task from the lookup table. This field is nullable if the task type is not specified.

DriverIdstring uuid nullable

The unique identifier of the driver assigned to the task. This field is nullable if no driver is assigned.

ScheduleDatestring date-time nullable

The date and time when the task is scheduled to be performed. This field is nullable if the schedule date is not specified.

StatusIdinteger

The status identifier of the task, indicating its current state (e.g., pending, completed).

Notesstring nullable

Additional notes related to the task. This field is nullable if there are no notes.

GeneratePickListboolean

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

GeneratePickListTimestring nullable

The time when the pick list should be generated. This field is nullable if the pick list generation time is not specified.

GeneratePickListRangeinteger nullable

The range in minutes for generating the pick list. This field is nullable if the range is not specified.

ScheduleNextWorkingDayboolean

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

TimezoneOffsetnumber double

The timezone offset in hours for the scheduled task, relative to UTC.

AssignedToPatternIdinteger nullable

The unique identifier of the pattern to which the task is assigned. This field is nullable if the task is not associated with a pattern.

AssignedToScheduleIdinteger nullable

The unique identifier of the schedule to which the task is assigned. This field is nullable if the task is not associated with a schedule.

IsMobileboolean nullable

Indicates whether the task was created or updated via a mobile device. This field is nullable if the source of creation is not specified.

IsSeriesUpdateboolean nullable

Indicates whether the task is part of a series update. This field is nullable if the task is not part of a series.

OriginalDatestring date-time nullable

The original date of the task before any rescheduling. This field is nullable if there was no rescheduling.

IncompletionReasonIdinteger nullable

The unique identifier of the reason for task incompletion. This field is nullable if the task was completed.

IncompletionReasonstring nullable

The reason for task incompletion, if applicable. This field is nullable if the task was completed.

Response

The newly created scheduled 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.