List Production Schedule Lines

Beta
GET/v1/operations/production-schedules/{id}/lines

This endpoint is idempotent. Learn more

Returns the planned campaigns for a schedule version, in the order they run.

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

ID of the schedule version.

machine_ids[]optional array

Only return campaigns on these machines.

week_indexoptional integer

Only return campaigns in this horizon week, zero-based.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of production_schedule_line

Resources in this page.

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.

A campaign becomes released when its week is issued to the floor as a production run, and goes back to planned if that run is deleted.

sourcestringenumValues:solvermanual

Whether the solver or a person created the line.

Editing a solver-placed campaign turns it manual, and a regenerate that preserves hand work keeps exactly the campaigns marked that way.

reasonstringnullableenumValues:machine_downmaterial_shortagerush_order

Why the campaign was placed or last changed by hand.

Only hand changes record a reason, and a change that touches a frozen week has to supply one.

freeze_statusstringenumValues:frozenflexible

Whether the line is inside the frozen window, where changing it requires a reason for the deviation log.

production_runentitynullable

The production run this campaign's week was released as.

One run carries the whole week, so every campaign released alongside this one points at the same run.

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.

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 List Production Schedule Lines