Skip to content
LabelyardLabelyardLabelyard

Tape batches that wait for an action

GET
/api/v1/batches/runs/held
curl --request GET \
  --url https://example.com/api/v1/batches/runs/held \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

The tape runs (#277) that wait for a confirmation or stopped, oldest first, for the printers the caller may use; printer_id narrows it to one printer. An API key without admin scope, and a browser session signed in with one, sees only the runs that key submitted; SSO users and admin keys see all. Their actions are continue, reprint and discard on the batch, allowed to the same callers (another key gets 404).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
printer_id
Printer Id
Any of:
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Held Runs Api V1 Batches Runs Held Get
Array<object>
TapeRunRead

A tape batch that is printing, waits for a confirmation, or stopped (#277).

Positions are 1-based in print order (job_ids).

object
batch_id
required
Batch Id
string format: uuid
confirmed_job_ids
required
Confirmed Job Ids

Labels of an unknown group the user confirmed as printed (a reprint).

Array<string>
current_sub_job
required
Current Sub Job

The sub-job printing or waiting, 1-based.

integer
job_ids
required
Job Ids

The job of every label, in print order.

Array<string>
printer_id
required
Printer Id
string format: uuid
reprint_from
required
Reprint From

Lowest from_label a reprint accepts.

Any of:
integer
reprint_to
required
Reprint To

Highest from_label: one past the unknown group (only the not-started).

Any of:
integer
state
required
State

awaiting_confirmation: the next sub-job starts after POST .../continue. stopped: a group failed; the labels after it were not started. With stop_kind unknown the group’s outcome is unknown (an error while sending, or the status check after the group: on a PT the SNMP noPaper bit at tape end; whether a QL-820NWB reports a DK roll end is not verified); with refused the printer refused before anything was sent (wrong tape, no tape, cover open, unreachable). POST .../reprint picks it up, POST .../discard gives it up. Held runs are kept in memory: a hub restart fails every label that waited for a confirmation (tape_run_interrupted), and a stopped run cannot be reprinted after it.

string
Allowed values: printing awaiting_confirmation stopped
stop_code
required
Stop Code

Why the run stopped, e.g. tape_empty.

Any of:
string
stop_kind
required
Stop Kind

After a stop: the group’s outcome is unknown, or nothing of it was sent.

Any of:
string
Allowed values: unknown refused
sub_job_size
required
Sub Job Size
integer
sub_job_starts
required
Sub Job Starts

Where each sub-job starts in job_ids (0-based); a reprint re-splits.

Array<integer>
sub_jobs
required
Sub Jobs
integer
unknown_from
required
Unknown From

First label of the unknown group.

Any of:
integer
unknown_to
required
Unknown To

Last label of the unknown group.

Any of:
integer

Example 

[
  {
    "state": "printing",
    "stop_kind": "unknown"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}