Machine Downtime

The machine_downtime_event object

A period during which a machine was not running.

Downtime is what makes OEE Availability a measurement rather than an estimate. An event with no ended_at is still open, meaning the machine is down right now; a machine can only have one open event at a time.

idstring

Downtime event ID.

objectstringenumValues:machine_downtime_event

Resource type identifier.

machinemachinenullable

The machine that stopped.

idstring

Machine ID.

objectstringenumValues:machine

Resource type identifier.

namestring

Display name of the machine.

Unique within the account.

serial_numberstring

Serial number of the machine.

notesstringnullable

Free-form notes about the machine.

departmentdepartmentnullable

The department this machine belongs to.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentdepartmentnullable

The department the machine belongs to, captured when the event was logged.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

Always returned as null in this endpoint.
scanning_stationslistnullable

Scanning stations in this department.

Always returned as null in this endpoint.
machineslistnullable

Machines in this department.

Always returned as null in this endpoint.
labor_rateratenullable

Hourly labor rate for work done in this department (e.g. a changeover technician). Null when none is set.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

reasonmachine_downtime_reasonnullable

Why the machine stopped.

objectstringenumValues:machine_downtime_reason

Resource type identifier.

codestringenumValues:breakdownchangeovermaterial_shortage

Stable code identifying the reason.

namestringnullable

Display name of the reason.

oee_bucketstringnullableenumValues:availabilityperformancequality

Which OEE term this reason charges.

started_atstring (date-time)

When the machine stopped.

ended_atstring (date-time)nullable

When the machine started running again.

duration_secondsintegernullable

How long the machine was down, in seconds.

shift_atstring (date-time)

The business day the stoppage is counted against.

shift_codestringnullable

The shift the stoppage is counted against.

itemitemnullable

What the machine was running when it stopped.

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code, unique within the account.

descriptionstringnullable

Item description.

notesstringnullable

Free-form notes about the item.

typestringenumValues:productmaterialpart

What kind of item this is.

  • product: a finished product.
  • material: a raw material or component consumed in production.
  • part: a part used in production.
categoryitem_categorynullable

The category this item belongs to.

The category's unit group determines the base unit the item's rates (unit_value, unit_cost, burn_rate) are expressed in.

Always returned as null in this endpoint.
unit_valueratenullable

Selling value per unit, expressed as a rate (e.g. $25.50 / kg).

Always returned as null in this endpoint.
unit_costratenullable

Cost per unit, expressed as a rate (e.g. $10.00 / kg).

Always returned as null in this endpoint.
burn_rateratenullable

Rate at which this item is consumed in production, expressed as a quantity over time (e.g. 100 kg / hr).

Always returned as null in this endpoint.
attributeslistnullable

Attributes assigned to this item.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

production_runentitynullable

The production run in progress when the machine stopped.

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).

batchentitynullable

The batch in progress when the machine stopped.

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).

schedule_lineentitynullable

The scheduled campaign the stoppage interrupted.

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).

notestringnullable

Free-form notes about the stoppage.

reported_byactornullable

The actor that logged the event — a user, API key, or agent. Expandable.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

  • user: a human user account.
  • api_key: a programmatic caller authenticating with an API key.
  • agent: an automated agent acting on the account's behalf.
  • group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

  • For user actors: the user's email address.
  • For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

Always returned as null in this endpoint.
sourcestringenumValues:manualscannerinferred

How the event was recorded.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate Machine Downtime EventMachine DowntimePATCHUpdate Machine Downtime EventMachine DowntimeGETList Machine Downtime EventsMachine DowntimeGETList Machine Downtime ReasonsMachine DowntimeGETRetrieve Machine Downtime EventMachine DowntimeDELETEDelete Machine Downtime EventMachine Downtime