Skip to main content

RoutePlanningRun

A planning run, or a preview of one.

type RoutePlanningRun {
  actorName: String
  actorUserId: ID!
  endDate: DateTime!
  finishedAt: DateTime!
  id: ID
  isPreview: Boolean!
  replanMode: RoutePlanningReplanMode!
  reps: [RoutePlanningRunRep!]!
  startDate: DateTime!
  startedAt: DateTime!
  totals: RoutePlanningRunTotals!
  trigger: RoutePlanningRunTrigger!
  undoBlockedReason: String
  undoable: Boolean!
  undoneAt: DateTime
  undoneByUserId: ID
}

Fields

`RoutePlanningRun.actorName` ● `String` scalar

The name of the person who ran it. Empty for a scheduled run.

`RoutePlanningRun.actorUserId` ● `ID!` non-null scalar

The ID of the user the run acted as.

`RoutePlanningRun.endDate` ● `DateTime!` non-null scalar

The last day planned.

`RoutePlanningRun.finishedAt` ● `DateTime!` non-null scalar

When the run finished.

`RoutePlanningRun.id` ● `ID` scalar

The ID of the run. Empty for a preview.

`RoutePlanningRun.isPreview` ● `Boolean!` non-null scalar

True for a preview, which changed nothing.

`RoutePlanningRun.replanMode` ● `RoutePlanningReplanMode!` non-null enum

Whether existing stops were kept or rebuilt.

`RoutePlanningRun.reps` ● `[RoutePlanningRunRep!]!` non-null object

What the run did for each rep.

`RoutePlanningRun.startDate` ● `DateTime!` non-null scalar

The first day planned.

`RoutePlanningRun.startedAt` ● `DateTime!` non-null scalar

When the run started.

`RoutePlanningRun.totals` ● `RoutePlanningRunTotals!` non-null object

Totals over the reps.

`RoutePlanningRun.trigger` ● `RoutePlanningRunTrigger!` non-null enum

What started the run.

`RoutePlanningRun.undoBlockedReason` ● `String` scalar

Why the run can no longer be undone.

`RoutePlanningRun.undoable` ● `Boolean!` non-null scalar

True when the run can still be undone.

`RoutePlanningRun.undoneAt` ● `DateTime` scalar

When the run was undone.

`RoutePlanningRun.undoneByUserId` ● `ID` scalar

The ID of the user who undid the run.

Returned By

applyRoutePlanningRun mutation ● routePlanningRun query ● routePlanningRunPreview query ● routePlanningRuns query ● undoRoutePlanningRun mutation

Fields
Returned By