resumeJobStep

Live

resumeJobStep

Try this operation →Use Postman ↗

Resume a paused step on its reserved machine. Owner, admin, supervisor or assigned operator. Records a RESUME event.

POST/graphqlapp audience

Who can call this. Owner, admin, supervisor, operator.

Headers

Required Optional

AuthorizationstringRequired
Bearer <token>, issued for this endpoint's audience. The token decides the shop and roles; nothing in the request body can change them.
Example: Bearer eyJhbGciOiJFZERTQSJ9…
Content-TypestringRequired
Always application/json. Only POST is accepted.
Example: application/json
Idempotency-KeystringRequired
A key you generate once per user action (a UUID). Retrying with the same key never applies the change twice.
Example: 0192f0c1-9b2a-7d40-8c3e-1f5a6b7c8d9e
X-Request-IdstringOptional
Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.
Example: app-7f3c2a9e-checkout

Arguments

Required Optional

operationIdID!Required
Paused step id.
Example: "0192f0c1-0000-7000-8000-000000d30908"

Returns

Required Optional

resumeJobStepJobCard!Required
Resume a paused step on its reserved machine. Owner, admin, supervisor or assigned operator. Records a RESUME event.
Show children
- billingJobCardBilling!Required
  Whether the job has been invoiced.
  - INVOICEDAn invoice exists for the job.
  - NOT_INVOICEDNo invoice yet.
- cancelledAtStringOptional
  UTC cancellation time; retained for audit and direct lookup.
- codeString!Required
  The label on the paper card (“JOB1”).
- createdAtString!Required
  UTC time the card was made.
- customerIdID!Required
  The customer (see customer).
- customerNameString!Required
  The customer’s name.
- designApprovalDesignApproval!Required
  Whether the drawing is approved. Work is ready only once it is.
  - APPROVEDThe design is approved.
  - PENDINGWaiting for a decision.
  - REJECTEDThe design was rejected.
- designFileAppFileReferenceOptional
  The drawing.
  Show children
  - idID!Required
    File id; obtain authorised download URL from files API.
  - kindStringOptional
    Document category.
  - nameString!Required
    Display filename.
  - sizeBytesFloat!Required
    Size in bytes, safe integer.
- drawingNumberStringOptional
  Drawing reference for the floor; no prices or PO amount are exposed.
- dueDateString!Required
  The order’s promised date, YYYY-MM-DD in the shop’s timezone.
- idID!Required
  Stable id (UUIDv7).
  Example: "0192f0c1-0000-7000-8000-000000d200e7"
- jobNameStringOptional
  Job name.
- lastActivityAtString!Required
  UTC time anything on the card last moved. “Stuck” is measured from here.
- materialStringOptional
  Material.
- materialQcAcceptance!Required
  The incoming material check. Work is ready only once it is accepted.
  - ACCEPTEDPassed.
  - PENDINGWaiting for a decision.
  - REJECTEDFailed.
- materialSourceMaterialSourceOptional
  Where the material comes from; null until it is recorded.
  - BOUGHT_OUTBought from a supplier.
  - IN_HOUSECut from the shop’s own stock.
- numberStringOptional
  Permanent per-shop work order number, WO-<n>.
- operations[JobOperation!]!Required
  The steps, in order.
  Show children
  - completedAtStringOptional
    UTC time the step finished.
  - goodIntOptional
    Pieces recorded as good on completion.
  - idID!Required
    Stable id (UUIDv7).
  - isReworkBoolean!Required
    Whether machine QC reopened this step for rework.
  - machineCodeStringOptional
    The code of the machine used for this step.
  - machineIdIDOptional
    The machine it runs on, if one is assigned.
  - machineNameStringOptional
    That machine’s name.
  - nameString!Required
    What the step does.
  - operatorIdIDOptional
    The operator it is assigned to, if any.
  - operatorNameStringOptional
    That operator’s name.
  - quantityStartedIntOptional
    Batch quantity fixed when work starts.
  - rejectIntOptional
    Pieces recorded as reject on completion.
  - reworkIntOptional
    Pieces recorded as rework on completion.
  - scrapIntOptional
    Pieces recorded as scrap on completion.
  - seqInt!Required
    Order of the step, from 1.
  - startedAtStringOptional
    UTC time the step started.
  - statusJobOperationStatus!Required
    Where the step is.
    COMPLETEDFinished.
    PAUSEDStopped part-way.
    PENDINGNot started.
    RUNNINGBeing worked on now.
- orderIdID!Required
  The work order (see order).
- partNameString!Required
  Part name.
- partNumberStringOptional
  Part reference.
- poNumberString!Required
  The order’s PO number.
- priorityOrderPriority!Required
  The order’s priority.
  - HIGHAhead of other orders.
  - LOWFill gaps in the schedule.
  - MEDIUMThe default.
- qcHistory[QcRecord!]!Required
  Every check made on this card, oldest first.
  Show children
  - idID!Required
    Stable id (UUIDv7).
  - inspectorStringOptional
    Inspector’s name.
  - jobCardIdID!Required
    The job card checked.
  - jobOperationIdIDOptional
    The step checked; null for a raw material check.
  - kindQcKind!Required
    What was checked.
    MACHINEA finished operation.
    RMThe raw material, before the first operation.
  - operationNameStringOptional
    What the step does; null for a raw material check.
  - qrValueString!Required
    The job card’s QR text.
  - recordedAtString!Required
    UTC time the check was recorded.
  - recordedByIdID!Required
    Who made the check (User.id).
  - recordedByNameString!Required
    That person’s name.
  - rejectedMaterialRejectedMaterialOptional
    Set on a raw material rejection.
    Show children
    gradeString!Required
    Raw material grade.
    heatNumberString!Required
    Heat number.
    sizeString!Required
    Raw material size.
  - remarkStringOptional
    Inspector’s remark.
  - reportAppFileReferenceOptional
    The inspection report.
    Show children
    idID!Required
    File id; obtain authorised download URL from files API.
    kindStringOptional
    Document category.
    nameString!Required
    Display filename.
    sizeBytesFloat!Required
    Size in bytes, safe integer.
  - reports[AppFileReference!]!Required
    Latest 50 audited report attachments, newest first.
    Show children
    idID!Required
    File id; obtain authorised download URL from files API.
    kindStringOptional
    Document category.
    nameString!Required
    Display filename.
    sizeBytesFloat!Required
    Size in bytes, safe integer.
  - resultQcResult!Required
    The outcome.
    ACCEPTEDRaw material accepted.
    FAILEDOperation failed.
    PASSEDOperation passed.
    REJECTEDRaw material rejected.
  - stageString!Required
    Label shown in the app: “Incoming inspection”, “In-process QC” or “Final QC”.
- qrValueString!Required
  The text printed as a QR code on the card. Unique in the shop; jobCardByQr resolves it.
- quantityInt!Required
  Pieces to make.
- quotationAcceptance!Required
  Whether the customer accepted the quotation behind this job.
  - ACCEPTEDPassed.
  - PENDINGWaiting for a decision.
  - REJECTEDFailed.
- routeCardNoStringOptional
  Route card reference.
- statusJobCardStatus!Required
  Worked out from the operations.
  Example: "IN_PROGRESS"
  - COMPLETEDEvery operation is done.
  - IN_PROGRESSAt least one operation has started and not every one is done.
  - NOT_STARTEDNo operation has started.
  - PAUSEDAn operation is paused and none is running.

Errors

Code	HTTP	When
`JOB_OPERATION_NOT_FOUND`	`404`	The operation id is unknown in this shop (another shop's ids answer the same).

Every error has the same body. See Errors.

Rate limit tier

Tier: per user. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.