Create Machine Tasks

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/machine-tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "MachineId": 123,
    "TaskLutId": "<string>",
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ScheduleDate": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Notes": "<string>",
    "GeneratePickList": true,
    "GeneratePickListTime": "<string>",
    "GeneratePickListRange": 123,
    "ScheduleNextWorkingDay": true,
    "TimezoneOffset": 123,
    "AssignedToPatternId": 123,
    "AssignedToScheduleId": 123,
    "Pattern": {
      "PatternId": 123,
      "Name": "<string>",
      "Description": "<string>",
      "RepeatType": 123,
      "RepeatInterval": 123,
      "IsStatic": true,
      "StartOn": "2023-11-07T05:31:56Z",
      "EndOn": "2023-11-07T05:31:56Z",
      "EndAfter": 123,
      "RepeatOn": [
        {
          "Tasks": "<string>",
          "Days": "<string>",
          "Week": "<string>",
          "MonthDay": "<string>",
          "SetPos": "<string>",
          "RecurrenceEx": "<string>",
          "WeekNumber": "<string>"
        }
      ]
    },
    "IsMobile": true,
    "IsSeriesUpdate": true,
    "OriginalDate": "2023-11-07T05:31:56Z",
    "IncompletionReasonId": 123,
    "IncompletionReason": "<string>"
  }
]
'

[
  {
    "MachineId": 123,
    "TaskLutId": "<string>",
    "SchedulingId": 123,
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "DriverName": "<string>",
    "TimezoneOffset": 123,
    "ScheduleDate": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Notes": "<string>",
    "GeneratePickList": true,
    "GeneratePickListTime": "<string>",
    "GeneratePickListRange": 123,
    "ScheduleNextWorkingDay": true,
    "AssignedToPatternId": 123,
    "AssignedToScheduleId": 123,
    "IncompletionReason": "<string>",
    "IncompletionReasonImages": [
      {
        "EntityPictureId": 123,
        "EntityPictureUrl": "<string>"
      }
    ],
    "Pattern": {
      "PatternId": 123,
      "Name": "<string>",
      "Description": "<string>",
      "RepeatType": 123,
      "RepeatInterval": 123,
      "IsStatic": true,
      "StartOn": "2023-11-07T05:31:56Z",
      "EndOn": "2023-11-07T05:31:56Z",
      "EndAfter": 123,
      "RepeatOn": [
        {
          "Tasks": "<string>",
          "Days": "<string>",
          "Week": "<string>",
          "MonthDay": "<string>",
          "SetPos": "<string>",
          "RecurrenceEx": "<string>",
          "WeekNumber": "<string>"
        }
      ]
    },
    "IsClustered": true,
    "ClusterIds": "<string>",
    "CreatedBy": 123,
    "CreatedDt": "2023-11-07T05:31:56Z",
    "UpdatedBy": 123,
    "UpdatedDt": "2023-11-07T05:31:56Z",
    "isMobile": true,
    "isSeriesUpdate": true,
    "originalDate": "<string>",
    "IncompletionReasonId": 123,
    "IncompletionReasonName": "<string>"
  }
]

POST

Scheduling

schedule

machine-tasks

Create Machine Tasks

curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/machine-tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "MachineId": 123,
    "TaskLutId": "<string>",
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ScheduleDate": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Notes": "<string>",
    "GeneratePickList": true,
    "GeneratePickListTime": "<string>",
    "GeneratePickListRange": 123,
    "ScheduleNextWorkingDay": true,
    "TimezoneOffset": 123,
    "AssignedToPatternId": 123,
    "AssignedToScheduleId": 123,
    "Pattern": {
      "PatternId": 123,
      "Name": "<string>",
      "Description": "<string>",
      "RepeatType": 123,
      "RepeatInterval": 123,
      "IsStatic": true,
      "StartOn": "2023-11-07T05:31:56Z",
      "EndOn": "2023-11-07T05:31:56Z",
      "EndAfter": 123,
      "RepeatOn": [
        {
          "Tasks": "<string>",
          "Days": "<string>",
          "Week": "<string>",
          "MonthDay": "<string>",
          "SetPos": "<string>",
          "RecurrenceEx": "<string>",
          "WeekNumber": "<string>"
        }
      ]
    },
    "IsMobile": true,
    "IsSeriesUpdate": true,
    "OriginalDate": "2023-11-07T05:31:56Z",
    "IncompletionReasonId": 123,
    "IncompletionReason": "<string>"
  }
]
'

[
  {
    "MachineId": 123,
    "TaskLutId": "<string>",
    "SchedulingId": 123,
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "DriverName": "<string>",
    "TimezoneOffset": 123,
    "ScheduleDate": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Notes": "<string>",
    "GeneratePickList": true,
    "GeneratePickListTime": "<string>",
    "GeneratePickListRange": 123,
    "ScheduleNextWorkingDay": true,
    "AssignedToPatternId": 123,
    "AssignedToScheduleId": 123,
    "IncompletionReason": "<string>",
    "IncompletionReasonImages": [
      {
        "EntityPictureId": 123,
        "EntityPictureUrl": "<string>"
      }
    ],
    "Pattern": {
      "PatternId": 123,
      "Name": "<string>",
      "Description": "<string>",
      "RepeatType": 123,
      "RepeatInterval": 123,
      "IsStatic": true,
      "StartOn": "2023-11-07T05:31:56Z",
      "EndOn": "2023-11-07T05:31:56Z",
      "EndAfter": 123,
      "RepeatOn": [
        {
          "Tasks": "<string>",
          "Days": "<string>",
          "Week": "<string>",
          "MonthDay": "<string>",
          "SetPos": "<string>",
          "RecurrenceEx": "<string>",
          "WeekNumber": "<string>"
        }
      ]
    },
    "IsClustered": true,
    "ClusterIds": "<string>",
    "CreatedBy": 123,
    "CreatedDt": "2023-11-07T05:31:56Z",
    "UpdatedBy": 123,
    "UpdatedDt": "2023-11-07T05:31:56Z",
    "isMobile": true,
    "isSeriesUpdate": true,
    "originalDate": "<string>",
    "IncompletionReasonId": 123,
    "IncompletionReasonName": "<string>"
  }
]

Authorizations

Authorization

string

header

required

Enter your API key. It's required to authenticate API requests.

Body

application/json

MachineId

integer<int64>

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

TaskLutId

string | null

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

DriverId

string<uuid> | null

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

ScheduleDate

string<date-time> | null

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

StatusId

integer<int32>

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

Notes

string | null

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

GeneratePickList

boolean

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

GeneratePickListTime

string | null

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

GeneratePickListRange

integer<int32> | null

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

ScheduleNextWorkingDay

boolean

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

TimezoneOffset

number<double>

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

AssignedToPatternId

integer<int64> | null

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.

AssignedToScheduleId

integer<int64> | null

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.

Pattern

object

The pattern details associated with the task, if any.

Show child attributes

IsMobile

boolean | null

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

IsSeriesUpdate

boolean | null

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

OriginalDate

string<date-time> | null

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

IncompletionReasonId

integer<int32> | null

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

IncompletionReason

string | null

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

Response

200 - application/json

The newly created scheduled tasks.

MachineId

integer<int64>

The unique identifier of the machine associated with the task.

TaskLutId

string | null

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

SchedulingId

integer<int64>

The unique identifier of the scheduling instance.

DriverId

string<uuid> | null

The unique identifier of the driver assigned to the task.

DriverName

string | null

The name of the driver assigned to the task.

TimezoneOffset

number<double>

The timezone offset in hours for the scheduled task.

ScheduleDate

string<date-time> | null

The date and time when the task is scheduled.

StatusId

integer<int32>

The status identifier of the task.

Notes

string | null

Additional notes related to the task.

GeneratePickList

boolean

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

GeneratePickListTime

string | null

The time when the pick list is generated.

GeneratePickListRange

integer<int32> | null

The range in minutes for generating the pick list.

ScheduleNextWorkingDay

boolean

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

AssignedToPatternId

integer<int64> | null

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

AssignedToScheduleId

integer<int64> | null

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

IncompletionReason

string | null

The reason for task incompletion, if applicable.

IncompletionReasonImages

object[] | null

A list of images associated with the reason for task incompletion.

Show child attributes

Pattern

object

The pattern details associated with the task, if any.

Show child attributes

IsClustered

boolean | null

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

ClusterIds

string | null

The identifiers of the clustered tasks, if applicable.

CreatedBy

integer<int64>

The unique identifier of the user who created the task.

CreatedDt

string<date-time>

The date and time when the task was created.

UpdatedBy

integer<int64> | null

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

UpdatedDt

string<date-time> | null

The date and time when the task was last updated.

isMobile

boolean | null

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

isSeriesUpdate

boolean | null

Indicates whether the task is part of a series update.

originalDate

string | null

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

IncompletionReasonId

integer<int32> | null

The unique identifier of the reason for task incompletion.

IncompletionReasonName

string | null

The name of the reason for task incompletion.

Update Machine Tasks Delete Machine Tasks

⌘I

Guides

API Reference

Create Machine Tasks

Authorizations

Body

Response