Carbon

Print Job

The print job resource.

Basehttps://rest.carbon.ms/printJob
GET/printJob

List print jobs

Retrieve a paginated list of print jobs. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/printJob
curl --request GET \
  --url 'https://rest.carbon.ms/printJob?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "status": "string",
    "printerUrl": "string",
    "sourceDocument": "string",
    "sourceDocumentId": "xyz789",
    "description": "string",
    "origin": "string"
  }
]
GET/printJob

Retrieve a print job

Fetch a single print job by filtering on `id`.

Query parameters

idstring

Match on the print job's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/printJob
curl --request GET \
  --url 'https://rest.carbon.ms/printJob?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "status": "string",
  "printerUrl": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789",
  "description": "string",
  "origin": "string"
}
POST/printJob

Create a print job

Create a new print job.

Body parameters

statusstringrequired
contentTypestring
contentstring
printerUrlstringrequired
sourceDocumentstringrequired
sourceDocumentIdstringrequired
sourceDocumentReadableIdstring
descriptionstringrequired
originstringrequired
errorstring
attemptsintegerrequired
completedAttimestamp
POSThttps://rest.carbon.ms/printJob
curl --request POST \
  --url https://rest.carbon.ms/printJob \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"status":"string","printerUrl":"string","sourceDocument":"string","sourceDocumentId":"xyz789","description":"string","origin":"string","attempts":0}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "status": "string",
  "printerUrl": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789",
  "description": "string",
  "origin": "string"
}
PATCH/printJob

Update a print job

Update an existing print job, matched on `id`.

Body parameters

statusstringrequired
contentTypestring
contentstring
printerUrlstringrequired
sourceDocumentstringrequired
sourceDocumentIdstringrequired
sourceDocumentReadableIdstring
descriptionstringrequired
originstringrequired
errorstring
attemptsintegerrequired
completedAttimestamp
PATCHhttps://rest.carbon.ms/printJob
curl --request PATCH \
  --url 'https://rest.carbon.ms/printJob?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"status":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "status": "string",
  "printerUrl": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789",
  "description": "string",
  "origin": "string"
}
DELETE/printJob

Delete a print job

Delete a print job, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the print job to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/printJob
curl --request DELETE \
  --url 'https://rest.carbon.ms/printJob?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content