TRANXACT.AI Help

Platform · Printing

All Print Queues

The print jobs of every person: who printed what, on which printer, and where it stands. Release a held job, cancel one, move it to another printer, or open its PDF.

Type REST13 operationsBase path /api/platform/print-jobsPublished as /api/v1/print-jobs

Download specification (OpenAPI 3.1) Screen: All Print Queues

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › All Print Queues on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableplatform.print_jobs · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

13 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/print-jobsList all print queues

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "title": "Example",
      "doc_kind": "text",
      "module": "text",
      "resource": "text",
      "record_id": "text",
      "source": "text",
      "printer_code": "PRI-000001",
      "copies": 10,
      "status": "draft",
      "pdf": "text",
      "pdf_bytes": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/print-jobs?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/print-jobs/{id}Read one print job

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "title": "Example",
  "doc_kind": "text",
  "module": "text",
  "resource": "text",
  "record_id": "text",
  "source": "text",
  "printer_code": "PRI-000001",
  "copies": 10,
  "status": "draft",
  "pdf": "text",
  "pdf_bytes": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/print-jobs/summarySummary

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/print-jobs/summary" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/print-jobs/queueQueue

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/print-jobs/queue" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/print-jobs/{id}/pdfPdf

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pdf" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/print-jobs/{id}/releaseRelease

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/print-jobs/{id}/cancelCancel

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/print-jobs/{id}/reassignReassign

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

printer, copies

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reassign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"printer":"value","copies":"value"}'
POST/api/platform/print-jobs/{id}/mark-printedMark printed

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mark-printed" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/print-jobsPost all print queues

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/print-jobs" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/print-jobs/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/platform/print-jobs/{id}Put all print queues

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/print-jobs/{id}Delete all print queues

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/print-jobs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a print job, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
user_iduuidread onlyUser id
titletextread onlyTitle
doc_kindtextread onlyDoc kind
moduletextread onlyModule
resourcetextread onlyResource
record_idtextread onlyRecord id
sourcetextread onlySource
printer_codetextread onlyPrinter code
copiesintegerread onlyCopies
statustextread onlyStatus
pdfbytearead onlyPdf
pdf_bytesintegerread onlyPdf bytes
pagesintegerread onlyPages
errortextread onlyError
released_byuuidread onlyReleased by
released_attimestamp with time zoneread onlyReleased at
printed_attimestamp with time zoneread onlyPrinted at
pdf_purged_attimestamp with time zoneread onlyPdf purged at
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › All Print Queues for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.