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.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

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.

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