Skip to content

ScheduleScenarioState ​

Type: Object

A versioned schedule scenario

Fields ​

NameTypeArgsDescriptionDeprecated
createdAtISO8601!ISO-8601 timestamp at which the scenario was first persisted. Never changes.
createdByUserIdUserIDTypeID 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.
idScheduleScenarioID!TypeID of this schedule scenario (prefix "sch", e.g. "sch_01K…").
lockedAtISO8601ISO-8601 timestamp at which the scenario was frozen by lockScheduleScenario. Null while the scenario is still editable; once set, all further updates are rejected.
nameString!Human-facing label for the scenario, unique only by convention. Cannot be blank.
planningHorizonEndISO8601ISO-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.
planningHorizonStartISO8601ISO-8601 timestamp at which the planning window opens. Null when the scenario has no bounded horizon.
scopeScheduleScope!Whether the scenario schedules the whole plant (GLOBAL) or a single production cell (PARTIAL, in which case targetProductionCellId is set).
statusScheduleStatus!Lifecycle status: DRAFT (being built), PUBLISHED (the schedule in force), ARCHIVED (superseded, kept for history), SIMULATION (what-if run, never in force).
targetProductionCellIdProductionCellIDTypeID of the production cell this scenario is confined to (prefix "pcl"). Required when scope is PARTIAL; null when scope is GLOBAL.
updatedAtISO8601!ISO-8601 timestamp of the most recent accepted mutation, including locking.
versionInt!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.

Connect machines, automate workflows, and build custom apps for print production.