Retrieve Machine Downtime Event

Beta

GET/v1/operations/machine-downtime-events/{id}

This endpoint is idempotent. Learn more

Returns a single machine downtime event.

Permissions requiredValues:machine_downtime:read

The role behind your API key or agent must grant every one of these permissions.

idstring

ID of the downtime event.

include[]optional arrayenumValues:machinedepartmentitem

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Downtime event ID.

objectstringenumValues:machine_downtime_event

Resource type identifier.

machinemachineExpandablenullable

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.

departmentdepartmentExpandablenullable

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.

departmentdepartmentExpandablenullable

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.

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.

itemitemExpandablenullable

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_byactorExpandablenullable

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.

Responses

200

Successful response for Retrieve Machine Downtime Event

Retrieve Machine Downtime Event

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const machineDowntimeEvent = await client.operations.machineDowntimeEvents.retrieve(
  'mcdt_0192a4c17b3e4f8a91c2d05e77',
);

console.log(machineDowntimeEvent.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const machineDowntimeEvent = await client.operations.machineDowntimeEvents.retrieve(
  'mcdt_0192a4c17b3e4f8a91c2d05e77',
);

console.log(machineDowntimeEvent.id);

200 example

{
  "id": "mcdt_0192a4c17b3e4f8a91c2d05e77",
  "object": "machine_downtime_event",
  "machine": {
    "id": "mc_0177d18f55a1615f783d3bf8d0",
    "object": "machine",
    "name": "CNC Router",
    "serial_number": "SN-2024-0001",
    "notes": null,
    "department": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "department": null,
  "reason": {
    "object": "machine_downtime_reason",
    "code": "breakdown",
    "name": "Breakdown",
    "oee_bucket": "availability"
  },
  "started_at": "2026-05-10T00:00:00Z",
  "ended_at": "2026-05-10T00:23:00Z",
  "duration_seconds": 3600,
  "shift_at": "2026-05-10T00:00:00Z",
  "shift_code": null,
  "item": null,
  "production_run": null,
  "batch": null,
  "schedule_line": null,
  "note": "Needle bar jam; replaced needle 42.",
  "reported_by": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": null
  },
  "source": "manual",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "mcdt_0192a4c17b3e4f8a91c2d05e77",
  "object": "machine_downtime_event",
  "machine": {
    "id": "mc_0177d18f55a1615f783d3bf8d0",
    "object": "machine",
    "name": "CNC Router",
    "serial_number": "SN-2024-0001",
    "notes": null,
    "department": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "department": null,
  "reason": {
    "object": "machine_downtime_reason",
    "code": "breakdown",
    "name": "Breakdown",
    "oee_bucket": "availability"
  },
  "started_at": "2026-05-10T00:00:00Z",
  "ended_at": "2026-05-10T00:23:00Z",
  "duration_seconds": 3600,
  "shift_at": "2026-05-10T00:00:00Z",
  "shift_code": null,
  "item": null,
  "production_run": null,
  "batch": null,
  "schedule_line": null,
  "note": "Needle bar jam; replaced needle 42.",
  "reported_by": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": null
  },
  "source": "manual",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Machine Downtime Event

Authorization

Path Parameters

Query Parameters

Returns

Responses