N1Developer docsv1

TYPE REFERENCE

Machine

Referenced by 7 generated operations.

Documented fields

  • codeString!Required

    code machine detail.

  • createdAtString!Required

    UTC time the machine was added.

    Example: "2026-06-14T04:30:00.000Z"

  • currentAssignmentMachineAssignmentOptional

    The open assignment, or null when the machine is not running a job.

    Example: {"id":"0192f0c1-0000-7000-8000-000000d60001","jobOperationId":"0192f0c1-0000-7000-8000-000000d300d4","jobCardId":"0192f0c1-0000-7000-8000-000000d20015","qrValue":"JC-00002","operationName":"Milling","startedAt":"2026-10-11T23:30:00.000Z"}

    Show children
    • idID!Required

      Stable id (UUIDv7).

      Example: "0192f0c1-0000-7000-8000-000000d60001"

    • jobCardIdID!Required

      The job card it belongs to.

      Example: "0192f0c1-0000-7000-8000-000000d20015"

    • jobOperationIdID!Required

      The step being run (JobOperation.id).

      Example: "0192f0c1-0000-7000-8000-000000d300d4"

    • operationNameString!Required

      What the step does.

      Example: "Milling"

    • qrValueString!Required

      That job card’s QR text.

      Example: "JC-00002"

    • startedAtString!Required

      UTC time the machine was assigned.

      Example: "2026-10-11T23:30:00.000Z"

  • currentWorkMachineWorkOptional

    Current work, or null.

    Show children
    • operatorString!Required

      Operator name.

    • titleString!Required

      Job title.

    • workOrderIdID!Required

      Order id.

  • idID!Required

    Stable id (UUIDv7).

    Example: "0192f0c1-0000-7000-8000-000000d40001"

  • kindString!Required

    What sort of machine it is, such as “CNC lathe”.

    Example: "CNC lathe"

  • locationString!Required

    location machine detail.

  • modelString!Required

    model machine detail.

  • nameString!Required

    The name the shop calls it, such as “Lathe 3”.

    Example: "Lathe 1 (CNC)"

  • notesString!Required

    notes machine detail.

  • statusMachineStatus!Required

    What it is doing.

    Example: "RUNNING"

    • IDLEFree to take a job operation.
    • MAINTENANCEOut of service. It cannot be assigned work.
    • RUNNINGHas an open assignment. Set by assignMachine and releaseMachine, never by hand.
  • typeMachineType!Required

    Machine category.

    • CNC_LATHECNC lathe.
    • CNC_MILLCNC mill.
    • INSPECTIONInspection.
    • LATHELathe.
    • PACKINGPacking.
    • WELDINGWelding.
  • updatedAtString!Required

    UTC time of the last change.

    Example: "2026-10-12T04:30:00.000Z"

Used by

Search documentation

Search operations, types and errors from the generated contract.