Skip to main content
GET
/
v1
/
Scheduling
/
schedule
/
machine-tasks
Get Machine Tasks
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/machine-tasks \
  --header 'Authorization: <api-key>'
[
  {
    "MachineId": 123,
    "RouteId": 123,
    "RouteName": "<string>",
    "VisitDate": "2023-11-07T05:31:56Z",
    "ScheduleTasks": [
      {
        "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.

Query Parameters

StartDate
string<date-time>

The start date of the task scheduling period.

EndDate
string<date-time>

The end date of the task scheduling period.

SchedulingId
integer<int64>

The unique identifier for the specific scheduling instance.

ActorId
integer<int32>

The unique identifier for the actor associated with the task.

MachineId
integer<int64>

The unique identifier for the machine associated with the task.

DriverId
string<uuid>

The unique identifier for the driver assigned to the task.

RouteId
integer<int64>

The unique identifier for the route associated with the task.

TimePeriod
integer<int32>
default:31

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

IsForlist
boolean
default:true

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

IsStatic
boolean

A flag indicating if the tasks are static.

Response

200 - application/json

A list of scheduled machine tasks matching the specified criteria.

MachineId
integer<int64>

The unique identifier of the machine associated with the task.

RouteId
integer<int64> | null

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

RouteName
string | null

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

VisitDate
string<date-time> | null

The date and time of the scheduled visit.

ScheduleTasks
object[] | null

A list of scheduled tasks associated with the machine.