Update Production Schedule Line

Beta
PATCH/v1/operations/production-schedules/{id}/lines/{line_id}

Idempotent with Idempotency-Key header. Learn more

Edits a campaign on a schedule.

Every change is written to the deviation log with a full before-and-after snapshot, and the line becomes manual so a regenerate can tell it apart from solver output. A change that touches a frozen week — including moving a campaign out of one — requires a reason.

Permissions requiredValues:production_schedules:update
The role behind your API key or agent must grant every one of these permissions.
idstring

ID of the production schedule.

line_idstring

ID of the schedule line.

week_indexoptional integer

Horizon week to move the campaign to, zero-based.

machine_idoptional string

ID of the machine to move the campaign to.

quantityoptional number

Units to build.

lotsoptional integer

Lots the quantity represents.

run_hoursoptional number

Machine hours the campaign will take.

sequence_indexoptional integer

Position within the week's run order.

statusoptional stringenumValues:plannedreleasedin_progress

Lifecycle state of the campaign.

reasonoptional stringnullableenumValues:machine_downmaterial_shortagerush_order

Why the campaign changed. Required when the change touches a frozen week. Send null to clear.

reason_noteoptional string

Free-form explanation of the change.

idstring

Line ID.

objectstringenumValues:production_schedule_line

Resource type identifier.

production_scheduleentitynullable

The schedule version this line belongs to.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

week_indexinteger

Zero-based week offset from the start of the horizon.

week_starts_atstring (date-time)

First instant of the week this campaign runs in.

machineentitynullable

The machine assigned to the campaign.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

production_stepentitynullable

The production step the campaign runs at.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

departmententitynullable

The department the machine belongs to.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

itementitynullable

The item to produce.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

planned_quantitynumber

Quantity to produce.

planned_unitentitynullable

Unit the quantity is expressed in.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

planned_unit_abbreviationstringnullable

Abbreviation of the unit every quantity on this line is counted in, for display.

A campaign of 360 means 360 pairs or 360 eaches depending on this, so the two are never meaningful apart.

planned_lotsinteger

Whole lots the quantity rounds to.

planned_lot_unitsnumber

Units in one lot, which is the batch size the week is released to the floor in.

planned_run_hoursnumber

Constraint hours the campaign consumes.

planned_changeover_minutesnumber

Modelled changeover time before the campaign.

sequence_indexinteger

Order the campaign runs within its week.

projected_on_hand_beforenumber

Projected stock before the campaign lands.

projected_on_hand_afternumber

Projected stock after the campaign lands and the week's demand is drawn down.

statusstringenumValues:plannedreleasedin_progress

Where the line is in its lifecycle.

sourcestringenumValues:solvermanual

Whether the solver or a person created the line.

reasonstringnullableenumValues:machine_downmaterial_shortagerush_order

Why the campaign was scheduled.

freeze_statusstringenumValues:frozenflexible

Whether the line is inside the frozen window and can no longer be changed without recording a deviation.

production_runentitynullable

The production run created from this line.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

released_batch_countinteger

Batches this campaign issued to the floor when its week was released.

Zero until the week is released.

scanned_batch_countinteger

Batches of this campaign the floor has scanned.

scanned_quantitynumber

Quantity scanned so far, in the planned unit.

Measured from the run the week was released as, matched on this campaign's item, so a run holding several SKUs credits each campaign with only its own work.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Production Schedule Line