← API reference
CANONICAL TYPE REFERENCE

ScheduleScenarioState

A versioned schedule scenario

TypeID of this schedule scenario (prefix "sch", e.g. "sch_01K…").

nameString!

Human-facing label for the scenario, unique only by convention. Cannot be blank.

Planner-assigned revision number for this scenario. At least 1; defaults to 1 on create. Not an optimistic-concurrency token — the server never bumps it, callers set it.

Lifecycle status: DRAFT (being built), PUBLISHED (the schedule in force), ARCHIVED (superseded, kept for history), SIMULATION (what-if run, never in force).

Whether the scenario schedules the whole plant (GLOBAL) or a single production cell (PARTIAL, in which case targetProductionCellId is set).

TypeID of the production cell this scenario is confined to (prefix "pcl"). Required when scope is PARTIAL; null when scope is GLOBAL.

ISO-8601 timestamp at which the planning window opens. Null when the scenario has no bounded horizon.

ISO-8601 timestamp at which the planning window closes. Must be strictly after planningHorizonStart when both are set. Null when the scenario has no bounded horizon.

TypeID of the user who created the scenario (prefix "usr"). Null when it was created by a non-user principal, e.g. an automated planning run.

ISO-8601 timestamp at which the scenario was frozen by lockScheduleScenario. Null while the scenario is still editable; once set, all further updates are rejected.

ISO-8601 timestamp at which the scenario was first persisted. Never changes.

ISO-8601 timestamp of the most recent accepted mutation, including locking.

View exact SDL
"""A versioned schedule scenario"""
type ScheduleScenarioState {
  """TypeID of this schedule scenario (prefix "sch", e.g. "sch_01K…")."""
  id: ScheduleScenarioID!
  """
  Human-facing label for the scenario, unique only by convention. Cannot be blank.
  """
  name: String!
  """
  Planner-assigned revision number for this scenario. At least 1; defaults to 1 on create. Not an optimistic-concurrency token — the server never bumps it, callers set it.
  """
  version: Int!
  """
  Lifecycle status: DRAFT (being built), PUBLISHED (the schedule in force), ARCHIVED (superseded, kept for history), SIMULATION (what-if run, never in force).
  """
  status: ScheduleStatus!
  """
  Whether the scenario schedules the whole plant (GLOBAL) or a single production cell (PARTIAL, in which case targetProductionCellId is set).
  """
  scope: ScheduleScope!
  """
  TypeID of the production cell this scenario is confined to (prefix "pcl"). Required when scope is PARTIAL; null when scope is GLOBAL.
  """
  targetProductionCellId: ProductionCellID
  """
  ISO-8601 timestamp at which the planning window opens. Null when the scenario has no bounded horizon.
  """
  planningHorizonStart: ISO8601
  """
  ISO-8601 timestamp at which the planning window closes. Must be strictly after planningHorizonStart when both are set. Null when the scenario has no bounded horizon.
  """
  planningHorizonEnd: ISO8601
  """
  TypeID of the user who created the scenario (prefix "usr"). Null when it was created by a non-user principal, e.g. an automated planning run.
  """
  createdByUserId: UserID
  """
  ISO-8601 timestamp at which the scenario was frozen by lockScheduleScenario. Null while the scenario is still editable; once set, all further updates are rejected.
  """
  lockedAt: ISO8601
  """
  ISO-8601 timestamp at which the scenario was first persisted. Never changes.
  """
  createdAt: ISO8601!
  """
  ISO-8601 timestamp of the most recent accepted mutation, including locking.
  """
  updatedAt: ISO8601!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.