Changelog

2021-03-01

  • Added an alternative version of the /submit end-point, that allows users to change print job properties like color and duplex that are defined in the request body.
    See New Submit method for more information.

  • Added new changelog section to the API documentation.

Introduction

The Printix Cloud Print API is intended for use by applications that wish to push print jobs in PDF or native format into a Printix queue.

Creating and printing a document is a multistage process, consisting of:

  1. Fetching a list of printers. (See List Printers)

  2. Selecting a printer. (See Get printer properties)

  3. Creating a job for that printer. (See Submit a job)

  4. Making a PUT request to the cloud storage links returned in the previous step’s response, including the document to print in the request body. (See Upload a file)

  5. Using the uploadCompleted link present in the response from step 3 to inform Printix that the document has been submitted and uploaded and is ready to be printed. (See Complete Upload).

Each of these four steps is detailed in their respective sections of this document.

API Conventions

Please be aware that use of the API may be throttled if an application makes too many requests in a short amount of time: the current threshold is set to 100 request per minute per user, which we estimate would allow a user to submit an average of 20 jobs each minute.
See the Rate Limiting section for more information.
Terminology: The word "Resource" is used to refer to a single entity (printer, job etc) in it’s raw form. The word "Document" is used to describe a complete response, so a resource or multiple resources and whatever container elements they may be returned in.

This API makes use of the HAL document format As such, it is intended to be discoverable by only having knowledge of the API entrypoint (see root request). All successful responses contains links that allow exploring the rest of the API. As such, consumers of the API are encouraged to not try to manually construct URLs, but instead make use of the ones returned by previous API responses. An example response looks like:

{
  "_links" : {
    "self" : {
      "href" : [the url of the returned document] ,
      "templated" : true
    },
    "multiples": [{
      "href" : [a single link ] ,
      "templated" : true
      },{
      "href" : [another single link] ,
      "templated" : true
      }
    ]
  },
  ...object properties in json
}
It’s worth noting that, according to the spec, a link relation may be represented as either an object (if there’s only one), or an array (if there are more).
This may represent a challenge.

Resource lists (jobs, printers) are returned in a paginated container format, with information about the current page (page number, page size, total elements and total page count) and links to next and previous page if these exist.

{
  "_links" : {
    "self" : {
      "href" : [the url of the returned document],
      "templated" : true
    },
    "next" : {
       "href" : [link  to next page of element],
    }
  },
  "success" : true,
  "message" : "OK",
  "printers" : [ ],
  "page" : {
    "size" : 100,
    "totalElements" : 101,
    "totalPages" : 2,
    "number" : 1
  }
}

See the individual resource descriptions below for a more detailed view of resource structures.

Authentication

The service interacting with Printix must first acquire a set of service tokens. This is done using the Client Credentials flow of oauth 2

The service is provided, out of band, with a credential set consisting of a client ID and a client secret. These are posted to the Printix token endpoint.

The client ID and secret necessary to authenticate with the API can be obtained through the Printix Administrator dashboard, please refer to the Printix Administrator manual for instruction on how to generate a set of API credentials.

A client ID and secret can be used to get an access token, by sending a POST request to the Printix token endpoint:

$ curl 'https://auth.printix.net/oauth/token'  -X POST \
    -H 'Content-Type: application/x-www-form-urlencoded'\
    -d 'grant_type=client_credentials&client_id={clientId}&client_secret={clientSecret}

In case of success the response will be

Content-Type: application/json;charset=UTF-8

{
  "access_token": "5a8c4ec4-ff70-4f4c-b088-29a8cae38062",
  "refresh_token": "e6f05338-9d27-466b-afa8-0ce72945da7d",
  "expires_in": 3599
}

Each access token is valid for one hour, after which it will need to be refreshed by getting a new one.

To Refresh a token, send a POST request to the Printix token endpoint:

curl 'https://auth.printix.net/oauth/token'  -X POST \
    -H 'Content-Type: application/x-www-form-urlencoded'\
    -d 'grant_type=refresh_token&client_id={clientId}&refresh_token={refreshToken}'

In case of success the response will be

Content-Type: application/json;charset=UTF-8

{
  "access_token": "5a8c4ec4-ff70-4f4c-b088-29a8cae38062",
  "refresh_token": "e6f05338-9d27-466b-afa8-0ce72945da7d",
  "expires_in": 3599
}

Store the refresh token returned in the response, and use that for the next token refresh. The refresh token will not be updated on every request, but you still make sure, you’re using the latest.

Rate Limiting

Rate limiting is implemented using a Token Bucket Algorithm: in short, the server allocates a "bucket" containing a certain amount of tokens (100 in our case), and every time a request is made to the API a token is consumed. The tokens are refilled at a fixed time interval (60 seconds), and if a request comes in but the token bucket is empty, the incoming request is throttled.

Upon a successful request, the response will contain the header X-Rate-Limit-Remaining which indicates the remaining number of tokens for a given time interval.
If on the other hand, a request is throttled and returns HTTP status code 429, the response will contain the custom header X-Rate-Limit-Retry-After-Seconds indicating how many seconds to wait for before retrying.

Throttling applies equally to all end-points, with the same rate of 100 requests per minute per user. Given these values, users should expact to be able to process around 20 print jobs per minute.

Root request

The API entry point is located at https://api.printix.net/cloudprint
This end-point takes no request parameters, and returns a list of links to accessible tenants.

Code Example Root Example

Submit a job

The /submit end-point is used to submit a document for printing.

This end-point creates a new Printix job using a title parameter and various values specified in the request body:
It creates a new job with the title and properties specified in the body, and returns the job’s metadata, alongside two sets of links:

  • A link to upload the file to be printed to Printix cloud storage (using either an Azure or Google Cloud Platform backend)

  • An uploadCompleted link used to notify Printix the upload was completed and the job is ready for printing.

These links will be used after the document has been submitted, to upload the file to cloud storage and finally start the printing process with a request to the /completeUpload end-point.

This end-point takes three parameters:

  • The title parameter is a string representing the title of the print job inside the Printix system. It is not mandatory for this parameter to be equal to the title of the document to print: it may be beneficial for consistency, however it is possible to use an arbitrary name for this parameter.

  • The user parameter is an optional parameter that specifies which user is going to print the current job being submitted. This parameter should be used for scenarios where it is necessary to use the Printix Redirector software, such as USB Printing or integration with third-party print solutions.

The Printix Administrator Manual contains further information on both USB printing, and Integration with third-party Print solutions.

In the case of USB printing it is not necessary to provide the Printix Redirector with a specific user name, so the parameter may be omitted to set to an arbitrary name.
In the case of integration with third-party solutions however, the user parameter should be set to the same user name used in the third-party software. It is important to use the exact same formatting in the user parameter in order for the Printix Redirector to work.

  • The PDL parameter is an optional parameter describing the Page Description Language that the document is in: Examples include PostScript or PCL. This parameter is used to specify the document to be printed is not a PDF and should be handled accordingly by the print queue driver. It is thus not necessary to have this parameter when printing native PDF documents.

The PDL parameter can accept one of the following values:

  • PCL5

  • PCLXL

  • POSTSCRIPT

  • UFRII

  • TEXT

  • XPS

The body for a submit request should be a Print Ticket, describing some properties about the document to be printed, such as color and duplex support and the number of copies to print.

Please be aware that setting custom paper sizes is not supported, changing fields inside the request body will not change the document output.
Users who wish to change color, duplex, paper size and other such print job properties should use the New Submit method instead.
To use non-standard document dimensions outside of the supported paper sizes, for example for use with label printers, please submit a document in native print format instead of PDF.

Request parameters:

Parameter Description

title

The title of the printjob

user

The name of the user that is printing, for integration with third-party print solutions

PDL

The Printer Document Language to use for the document to be printed, if it is not PDF

Response:

This API call returns the following:

  • A boolean success indicator.

  • A description of the print job that was created, with its metadata,

  • Upload links to the tenat’s preferred cloud storage service, to which the document to be printed should be uploaded.

  • A uploadCompleted link to be used with the /completeUpload end-point.

Below is a breakdown of the fields returned in the response.

Path Type Description

job.id

String

The id of the generated printjob

job.createTime

Number

Unix timestamp for when the job was created

job.updateTime

Number

Unix timestamp of when this job was last updated(for new jobs, this will be the same as createTime

job.status

String

Current state of the job

job.ownerId

String

The id of the owner of this job. For jobs created with client credentials this will always be the client_id

job.contentType

String

The content type of the uploaded document.

job.title

String

The title of the printjob. matching the request parameter given when creating the job

_links.uploadCompleted

Object

Link to be used once a job has completed uploading, to initiate the print process

uploadLinks

Array

document upload link

uploadLinks.[0].url

String

The actual url to upload the document data (Using http PUT)

uploadLinks.[0].headers

Object

Any additional headers to add to the PUT request

Error Handling

This end-point returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the supplied printer specified in the request could not be found. A 500 error is thrown if other errors occur. In both cases, the response body contains an error description and an internal error ID for troubleshooting

Code example: Submit Example

New Submit method

For users that wish to modify print job proprieties such as color, duplex, or paper sizes, a new version of the /submit has been made available: this new version of the end-point works in the same manner as the original one (see Submit a job), but uses a different request body.

To use it, simply add a version header to the request, with the value of 1.1.

The possible values for the request body are shown below:

Request body parameters

Parameter Description

color

Sets whether the document should be printed in color.
Possible values are true or false

duplex

Sets what kind of duplex to use to print the document, if any.
Possible values are NONE, SHORT_EDGE or LONG_EDGE

page_orientation

Sets the page orientation.
Possible values are PORTRAIT, LANDSCAPE or AUTO

copies

A positive integer, representing the number of copies to print

media_size

Sets the page dimensions for the document to be printed.
Choose one of the following Paper size values

scaling

Determines how the job should be scaled if at all; if set the document will be scaled to the paper size
Possible values are: NOSCALE, SHRINK, FIT.

Paper size values

  • A0, A1, A2, A3, A4, A5, B4, B5

  • ISOA0, ISOA1, ISOA2, ISOA3, ISOA4, ISOA5, ISOB4, ISOB5

  • LETTER

  • LEGAL

  • EXECUTIVE

  • EXEC

  • COM10

  • MONARCH

  • DL

  • ANSIC, ANSID, ANSIE, ARCHC, ARCHD, ARCHE

  • TABLOID,

  • JISB5,

  • JISB4,

  • STATEMENT,

Upload a file

After a /submit request has completed successfully, it is up to the user or application to upload the document to cloud storage, so that it may be printed.

Please note that in order for uploading to work, the Cloud Storage of jobs should be enabled for the tenant. Both Azure and Google back-ends are supported. Instructions on how to enable cloud storage can be found in the Printix Administrator Manual

To upload a document to cloud storage, send a PUT request to the cloud storage url returned in the /submit response, using the document to be uploaded as a body. The /submit response also contains an additional field after the generated cloud storage url, that should be added as a custom header in the PUT request. This header varies depending on what storage provider is chosen.

Below is an example of how to upload a document to Azure blob storage using CURL: in this example we assume that we need to print a file called test.pdf located in the current working directory, and we use the url and headers returned in the Submit Example

1) We submit the document, setting the title parameter to a title of our choice.

2) We send a PUT request to the appropriate url based on our storage provider of choice, taking care to add the custom header.

The submit example uses Azure, and thus we will also add the custom header x-ms-blob-type with the appropriate value.

Be aware that this is just an example, the actual request URL and headers will vary based on which provider is used, the document to be uploaded and the time. Use the URL and headers provided in the submit response for your own request, and use the appropriate file path for your document in the --binary-data filed.
$ curl 'https://printixjobs.blob.core.windows.net/9aab9505-c84f-4dba-814f-d710b7c6d089/printix-jobs-file-upload/c5d97124-4e31-4a83-887b-b52b6d53249e?sig=3FlDWWBnr7704VgZjjApglkioBcUkS9F%2FZXJAVbBmAY%3D&st=2020-09-17T12%3A11%3A14Z&se=2020-09-17T13%3A26%3A14Z&sv=2017-04-17&sp=cw&sr=b' -i \
-X POST \
-H 'Content-Type: application/pdf' \
-H 'x-ms-blob-type: BlockBlob' \
--data-binary '@./test.pdf'

Error Handling

If the upload is performed successfully, it will return a 201 or 200 status code.

Please be aware that uploading a file to cloud storage does not require the same authentication as other API end-points: Azure and/or Google will handle the authentication for this particular request.

GCP and Azure will not recognize Printix Cloud Print API tokens and will return a 403 error is the user tries to send an API tokens along with the request.
In practice, users should use no explicit authentication for this step.

Other failure scenarios will return a 500 error.

Complete Upload

The /completeUpload end-point is the final step in the workflow necessary to submit a document for printing using this API: it informs Printix that the job submission and subsequent upload has completed successfully.

Once the Printix system has been notified that the user has submitted and uploaded a document, it will take care of converting the document if necessary, and queue it for printing on the appropriate printer. The job will be printed on the printer and printer queue that were specified during a previous /submit request.

This end-point takes no request parameters; it returns a boolean success indicator, alongside metadata for the job indicating that it is being processed.

Error Handling

This end-point returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the specified printer or job could not be found. A 500 error is thrown if other errors occur. In both cases, the response body contains an error description and an internal error ID for troubleshooting.

Code Example: Complete Upload Example

Retrieve Jobs

The /jobs end-point (plural) is used to retrieve a list of jobs for the authenticated user. There are two ways to call the /jobs end-point, as a request can be made with or without specifying printer ID and queue ID.

If a request is made without specifying a printer ID and queue ID, this end-point will return a list of all jobs associated with the authenticated user, irrespective of what printer they are associated with.
If, on the other hand, the user specifies the printer ID and queue ID, this request will return a list of jobs on that queue.

To illustrate the difference, note the difference between the request URLs in the examples: sending a request to

/cloudprint/tenants/b54aed12-c905-4dd1-a69f-5b34aec43533/jobs

will retrieve all jobs for that tenant, while a request sent to

 /cloudprint/tenants/2b137cb3-8cd3-4dd6-9983-64b1ee2c8b23/printers/581cd264-ccda-4407-b0c5-fb87bd42e95f/queues/498eb501-ae20-40b5-9779-be8d20dbdfa7/jobs

will retrieve jobs for that same tenant, but only for the specified queue.

Request parameters

Both versions of this end-point can take the following optional parameters: Unresolved directive in index.adoc - include::generated-snippets/jobList/request-parameters.adoc[]

Response

Both versions of the end-point return a boolean success indicator and a paged list of jobs.

Below is a breakdown of the fields returned in the response. Unresolved directive in index.adoc - include::generated-snippets/jobList/response-fields.adoc[]

Error Handling

This end-point returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the jobs or specified printer could not be found. A 500 error is thrown if other errors occur. In both cases, the response body contains an error description and an internal error ID for troubleshooting.

General Code Example: Job List Example

Code Example with a printer specified: Printer Job List Example

Retrieve a single Job

The /job end-point (singular) is used to retrieve a single job, for example to check its status after it has been submitted. This end-point takes no parameters, it returns a boolean success indicator and information for the job that was queried.

Error Handling

This end-point returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the specified job could not be found. A 500 error is thrown if other errors occur.

Code Example: Job Example

Delete a single Job

The /delete end-point is used to delete a single job. for example to clean out jobs were submitted but not printed, or jobs that failed to print.

This end-point takes no parameters, it returns a boolean success indicator and a message confirming that the job has been deleted.

Error Handling

This end-point returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the job to delete could not be found. A 500 error is thrown if other errors occur.

Code Example: Delete Example

Get printer properties

The /printer end-point (singular) can be used to receive all fields of a specified printer, including its capabilities. It takes no request parameters, and returns boolean success indicator and a paged singleton list containing the requested printer.

As a printer resource contains a lot of different fields whose meaning could be unclear, the table below is provided for the user’s convenience: Unresolved directive in index.adoc - include::generated-snippets/printerInfo/response-fields.adoc[]

Error Handling

This end-point returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the specified printer could not be found. A 500 error is thrown if other errors occur. In both cases, the response body contains an error description and an internal error ID for troubleshooting.

Code Example: Printer Info Example

List Printers

The /printers end-point (plural) can be used to retrieve a list of printers for the authenticated user, alongside their capabilities.

Request Parameters

This request can take the following optional parameters: Unresolved directive in index.adoc - include::generated-snippets/printerList/request-parameters.adoc[]

Response

This request returns a boolean success indicator and a paged list of printers with their capabilities.

Below is a breakdown of the fields returned in the response. Unresolved directive in index.adoc - include::generated-snippets/printerList/response-fields.adoc[]

Error Handling

This end-point returns a false boolean success indicator in case of errors, as well as a description of the error.
The response body also contains an internal error ID for troubleshooting

Code Example: Printer List Example

Code Examples

Root Example

Request:

GET /cloudprint HTTP/1.1
Authorization: Bearer 029b143d-14a5-4eab-89e2-78e0fb6d2eb5
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: 1ohatmT9
Content-Type: application/json
Content-Length: 214

{
  "_links" : {
    "acme.printix.net" : {
      "href" : "https://api.printix.net/cloudprint/tenants/2d4caec1-4d77-4190-b771-0fa0579a4181/printers?page=0&pageSize=10{&query}",
      "templated" : true
    }
  }
}

Submit Example

Request:

POST /cloudprint/tenants/21e5a5cd-9729-4536-ba2d-a9d0118d5e43/printers/f7e2e7ec-6203-4003-84f0-43a8f5c778a4/queues/c6f21e69-25cb-448e-afc7-94b96050f5af/submit?title=a+title&user=John+Doe HTTP/1.1
Content-Type: application/json
Authorization: Bearer 1e6b6038-f92f-489c-97c0-4aba3ea09827
Accept: application/json
Content-Length: 195
Host: api.printix.net

{"vendor_ticket_item":[],"color":{"vendor_id":null,"type":"STANDARD_COLOR"},"duplex":{"type":"NO_DUPLEX"},"page_orientation":{"type":"AUTO"},"copies":{"copies":1},"media_size":{"mediaSize":"A4"}}

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: wgddpxpE
Content-Type: application/json
Content-Length: 1341

{
  "job" : {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/21e5a5cd-9729-4536-ba2d-a9d0118d5e43/jobs/60f7e3ae-6df3-40f7-87a5-971888b6e59b"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/21e5a5cd-9729-4536-ba2d-a9d0118d5e43/printers/f7e2e7ec-6203-4003-84f0-43a8f5c778a4/queues/c6f21e69-25cb-448e-afc7-94b96050f5af"
      }
    },
    "id" : "60f7e3ae-6df3-40f7-87a5-971888b6e59b",
    "createTime" : 1.620135242377586E9,
    "updateTime" : 1.620135242384776E9,
    "status" : "AWAIT_PRINT",
    "ownerId" : "3ebafcee-f3c2-4ce7-aa8e-e0269a084310",
    "contentType" : "PDF",
    "title" : "a title"
  },
  "_links" : {
    "uploadCompleted" : {
      "href" : "https://api.printix.net/cloudprint/tenants/21e5a5cd-9729-4536-ba2d-a9d0118d5e43/jobs/60f7e3ae-6df3-40f7-87a5-971888b6e59b/completeUpload"
    }
  },
  "success" : true,
  "message" : "OK",
  "uploadLinks" : [ {
    "url" : "https://printixjobs.blob.core.windows.net/9aab9505-c84f-4dba-814f-d710b7c6d089/printix-jobs-file-upload/60f7e3ae-6df3-40f7-87a5-971888b6e59b?sig=3FlDWWBnr7704VgZjjApglkioBcUkS9F%2FZXJAVbBmAY%3D&st=2020-09-17T12%3A11%3A14Z&se=2020-09-17T13%3A26%3A14Z&sv=2017-04-17&sp=cw&sr=b",
    "headers" : {
      "x-ms-blob-type" : "BlockBlob"
    }
  } ]
}

Submit Example (version 1.1)

Request:

POST /cloudprint/tenants/3f549ae0-37b4-4daf-9e29-7e65b428673a/printers/b23c086d-caf6-4e2a-a914-3c9238049054/queues/3006f1b1-62ad-49fc-a269-b1579b4a317c/submit?title=a+title&user=John+Doe HTTP/1.1
Content-Type: application/json
Authorization: Bearer 37adb889-a98e-49b7-87ba-da2dac4b341f
version: 1.1
Accept: application/json
Content-Length: 137
Host: api.printix.net

{
  "color" : false,
  "duplex" : "NONE",
  "page_orientation" : "AUTO",
  "copies" : 1,
  "media_size" : "A4",
  "scaling" : "NOSCALE"
}

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: xDlDDXOl
Content-Type: application/json
Content-Length: 1341

{
  "job" : {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/3f549ae0-37b4-4daf-9e29-7e65b428673a/jobs/3047d8a4-dd66-47cb-b02d-c0833bf2f1d1"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/3f549ae0-37b4-4daf-9e29-7e65b428673a/printers/b23c086d-caf6-4e2a-a914-3c9238049054/queues/3006f1b1-62ad-49fc-a269-b1579b4a317c"
      }
    },
    "id" : "3047d8a4-dd66-47cb-b02d-c0833bf2f1d1",
    "createTime" : 1.620135242882418E9,
    "updateTime" : 1.620135242884033E9,
    "status" : "AWAIT_PRINT",
    "ownerId" : "d82c0cf7-b606-426a-aa43-2b75aae38272",
    "contentType" : "PDF",
    "title" : "a title"
  },
  "_links" : {
    "uploadCompleted" : {
      "href" : "https://api.printix.net/cloudprint/tenants/3f549ae0-37b4-4daf-9e29-7e65b428673a/jobs/3047d8a4-dd66-47cb-b02d-c0833bf2f1d1/completeUpload"
    }
  },
  "success" : true,
  "message" : "OK",
  "uploadLinks" : [ {
    "url" : "https://printixjobs.blob.core.windows.net/9aab9505-c84f-4dba-814f-d710b7c6d089/printix-jobs-file-upload/3047d8a4-dd66-47cb-b02d-c0833bf2f1d1?sig=3FlDWWBnr7704VgZjjApglkioBcUkS9F%2FZXJAVbBmAY%3D&st=2020-09-17T12%3A11%3A14Z&se=2020-09-17T13%3A26%3A14Z&sv=2017-04-17&sp=cw&sr=b",
    "headers" : {
      "x-ms-blob-type" : "BlockBlob"
    }
  } ]
}

Complete Upload Example

Request:

POST /cloudprint/tenants/20156467-09d7-41c3-a375-054bacd900de/jobs/a9e4ea99-10f9-4ca0-8cb8-322dbbd70ab9/completeUpload HTTP/1.1
Authorization: Bearer 8222f351-e844-4847-9029-11bb4993f2df
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: JVeudGnv
Content-Type: application/json
Content-Length: 915

{
  "tenantId" : "20156467-09d7-41c3-a375-054bacd900de",
  "sortOrder" : null,
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/20156467-09d7-41c3-a375-054bacd900de/jobs/a9e4ea99-10f9-4ca0-8cb8-322dbbd70ab9"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/20156467-09d7-41c3-a375-054bacd900de/printers/ac6304f2-8efe-4d31-bf83-6c26f615c5d0/queues/3699f538-d3fd-4083-bc0f-5bcdef60a1d8"
      }
    },
    "id" : "a9e4ea99-10f9-4ca0-8cb8-322dbbd70ab9",
    "createTime" : 1.620135227216897E9,
    "updateTime" : 1.620135242216833E9,
    "status" : "CONVERTING",
    "ownerId" : "c4f5f929-9991-43aa-a7ce-88e268da7080",
    "contentType" : "PDF",
    "title" : "job name"
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Job List Example

Request:

GET /cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs?page=0&pageSize=10 HTTP/1.1
Authorization: Bearer 90f91cd7-ba26-4d2a-9f8c-e7894c625424
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: aUTa4ypD
Content-Type: application/json
Content-Length: 9455

{
  "tenantId" : "496f6bec-5f83-47fd-8f57-59b7f595b1dd",
  "sortOrder" : null,
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs?page=0&pageSize=10{&sortorder}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs?page=1&pageSize=10{&sortorder}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/b9b1fb54-fc08-419c-a789-7db8881c2321"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "b9b1fb54-fc08-419c-a789-7db8881c2321",
    "createTime" : 1.620135227572661E9,
    "updateTime" : 1.620135242572614E9,
    "status" : "CONVERTING",
    "ownerId" : "60205cb0-0695-4119-8031-0c11743ff54d",
    "contentType" : "PDF",
    "title" : "job 0"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/dad53175-b4db-48ab-8af6-f3bd65a19e92"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "dad53175-b4db-48ab-8af6-f3bd65a19e92",
    "createTime" : 1.620135227572718E9,
    "updateTime" : 1.620135242572694E9,
    "status" : "CONVERTING",
    "ownerId" : "37622f33-189a-4438-8c21-af1f8cd3f186",
    "contentType" : "PDF",
    "title" : "job 1"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/42f96938-ad7b-4e75-9bee-f4e3d93d6f3a"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "42f96938-ad7b-4e75-9bee-f4e3d93d6f3a",
    "createTime" : 1.620135227572753E9,
    "updateTime" : 1.620135242572741E9,
    "status" : "CONVERTING",
    "ownerId" : "2024aa82-fa66-4d68-9ef7-d01402a8c8d8",
    "contentType" : "PDF",
    "title" : "job 2"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/03073352-5b5b-48fe-84e7-83dc7ed6d7b6"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "03073352-5b5b-48fe-84e7-83dc7ed6d7b6",
    "createTime" : 1.620135227572794E9,
    "updateTime" : 1.620135242572775E9,
    "status" : "CONVERTING",
    "ownerId" : "1a680a56-b5b5-4f6a-9e1e-b3ee914b28db",
    "contentType" : "PDF",
    "title" : "job 3"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/6a84a362-2726-4f1c-98c6-ceb9ca2bc94b"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "6a84a362-2726-4f1c-98c6-ceb9ca2bc94b",
    "createTime" : 1.62013522757284E9,
    "updateTime" : 1.620135242572816E9,
    "status" : "CONVERTING",
    "ownerId" : "25c717a5-0d52-4f26-a659-8a1aa26ded31",
    "contentType" : "PDF",
    "title" : "job 4"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/9f74840a-2814-4caa-8cb5-ec4f32b36764"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "9f74840a-2814-4caa-8cb5-ec4f32b36764",
    "createTime" : 1.620135227572905E9,
    "updateTime" : 1.620135242572856E9,
    "status" : "CONVERTING",
    "ownerId" : "e70842bb-95d2-4926-bb7e-4c56ebe29954",
    "contentType" : "PDF",
    "title" : "job 5"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/d7867dff-0287-4a05-97dd-e4f0da615f40"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "d7867dff-0287-4a05-97dd-e4f0da615f40",
    "createTime" : 1.62013522757296E9,
    "updateTime" : 1.620135242572934E9,
    "status" : "CONVERTING",
    "ownerId" : "aea9cac4-e9d2-4e9e-9928-a1673cb326d9",
    "contentType" : "PDF",
    "title" : "job 6"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/e03ff7ae-3f3a-48dc-a803-3cebc7bbb16f"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "e03ff7ae-3f3a-48dc-a803-3cebc7bbb16f",
    "createTime" : 1.62013522757303E9,
    "updateTime" : 1.620135242573019E9,
    "status" : "CONVERTING",
    "ownerId" : "f2da21a3-7c99-40fc-bd5c-b404d24b970e",
    "contentType" : "PDF",
    "title" : "job 7"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/efcfc769-2a3a-477c-bae1-857372f24d9e"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "efcfc769-2a3a-477c-bae1-857372f24d9e",
    "createTime" : 1.620135227573059E9,
    "updateTime" : 1.620135242573046E9,
    "status" : "CONVERTING",
    "ownerId" : "5fc7d41b-108f-4cfb-b9dc-aa53d33bea9b",
    "contentType" : "PDF",
    "title" : "job 8"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/fadaa7c9-f518-45d8-a67d-b1f5658ba0cb"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "fadaa7c9-f518-45d8-a67d-b1f5658ba0cb",
    "createTime" : 1.620135227573083E9,
    "updateTime" : 1.620135242573072E9,
    "status" : "CONVERTING",
    "ownerId" : "b4b9804e-e877-43d6-8ec7-2f75135d4563",
    "contentType" : "PDF",
    "title" : "job 9"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/12da7bca-4e0f-4900-a5b0-ffccde9c7365"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "12da7bca-4e0f-4900-a5b0-ffccde9c7365",
    "createTime" : 1.620135227573101E9,
    "updateTime" : 1.620135242573091E9,
    "status" : "CONVERTING",
    "ownerId" : "28bdcce6-7baa-4885-b362-92132326e160",
    "contentType" : "PDF",
    "title" : "job 10"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/9e51f815-6808-493d-9358-d7dc165fef91"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "9e51f815-6808-493d-9358-d7dc165fef91",
    "createTime" : 1.620135227573124E9,
    "updateTime" : 1.620135242573113E9,
    "status" : "CONVERTING",
    "ownerId" : "64815fd4-fd41-4466-b8a8-217cad683f74",
    "contentType" : "PDF",
    "title" : "job 11"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/jobs/eb701ddc-475a-4e6e-b4e2-58265583800b"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/496f6bec-5f83-47fd-8f57-59b7f595b1dd/printers/149d5bd0-3be5-4c2d-a48d-8b362ee7dfff/queues/53f29f8f-73c5-4117-8caf-d41a60a73de2"
      }
    },
    "id" : "eb701ddc-475a-4e6e-b4e2-58265583800b",
    "createTime" : 1.620135227573145E9,
    "updateTime" : 1.620135242573138E9,
    "status" : "CONVERTING",
    "ownerId" : "54ebe2d0-8b0c-49bb-b379-4df60ff11387",
    "contentType" : "PDF",
    "title" : "job 12"
  } ],
  "page" : {
    "size" : 10,
    "totalElements" : 13,
    "totalPages" : 2,
    "number" : 0
  }
}

Printer Job List Example

Request:

GET /cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395/jobs?page=0&pageSize=10 HTTP/1.1
Authorization: Bearer a11915a8-bdd8-4ccc-9d19-09a35526a0c1
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: nghxMNgh
Content-Type: application/json
Content-Length: 9558

{
  "tenantId" : "bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82",
  "sortOrder" : null,
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395/jobs?page=0&pageSize=10"
    },
    "next" : {
      "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395/jobs?page=1&pageSize=10"
    }
  },
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/b36566b1-b40a-4f93-b692-813f20ae2353"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "b36566b1-b40a-4f93-b692-813f20ae2353",
    "createTime" : 1.620135226918649E9,
    "updateTime" : 1.620135241917138E9,
    "status" : "CONVERTING",
    "ownerId" : "d7d67161-bffa-4d49-b21b-b93390f8df9b",
    "contentType" : "PDF",
    "title" : "job 0"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/0094d015-d0da-4eaa-9a84-b3f7aeec82d6"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "0094d015-d0da-4eaa-9a84-b3f7aeec82d6",
    "createTime" : 1.620135226919798E9,
    "updateTime" : 1.620135241919764E9,
    "status" : "CONVERTING",
    "ownerId" : "c3978d5a-5fdb-49de-a98c-d89c2d9ee136",
    "contentType" : "PDF",
    "title" : "job 1"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/0a6bd28e-6474-4d7e-b806-c59f6c384e6a"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "0a6bd28e-6474-4d7e-b806-c59f6c384e6a",
    "createTime" : 1.62013522691983E9,
    "updateTime" : 1.620135241919813E9,
    "status" : "CONVERTING",
    "ownerId" : "480d0743-cee6-4927-be26-ac9148a4a039",
    "contentType" : "PDF",
    "title" : "job 2"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/3b76b252-3fac-4ebb-adbd-03aa5860d9d3"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "3b76b252-3fac-4ebb-adbd-03aa5860d9d3",
    "createTime" : 1.620135226919923E9,
    "updateTime" : 1.620135241919849E9,
    "status" : "CONVERTING",
    "ownerId" : "6bb66679-18bd-40c6-a0ab-e62e1f3b7d1f",
    "contentType" : "PDF",
    "title" : "job 3"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/92cf4d63-e1d9-4fc8-abaa-b4cc3fcfa9ad"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "92cf4d63-e1d9-4fc8-abaa-b4cc3fcfa9ad",
    "createTime" : 1.62013522691996E9,
    "updateTime" : 1.62013524191995E9,
    "status" : "CONVERTING",
    "ownerId" : "1514c4b6-bfca-477f-909d-b503f085c40e",
    "contentType" : "PDF",
    "title" : "job 4"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/47df6d93-086d-4710-b0ac-b5c1a713e3da"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "47df6d93-086d-4710-b0ac-b5c1a713e3da",
    "createTime" : 1.620135226919996E9,
    "updateTime" : 1.620135241919979E9,
    "status" : "CONVERTING",
    "ownerId" : "259b2809-92b2-43c0-ae53-4d29d67d2792",
    "contentType" : "PDF",
    "title" : "job 5"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/60f31ec7-def9-4af6-bc8a-40a0fa1973f4"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "60f31ec7-def9-4af6-bc8a-40a0fa1973f4",
    "createTime" : 1.62013522692003E9,
    "updateTime" : 1.620135241920014E9,
    "status" : "CONVERTING",
    "ownerId" : "94f5f994-e4a0-43a1-8a37-f42ac7165350",
    "contentType" : "PDF",
    "title" : "job 6"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/9b95805f-316d-435e-a4e3-874834225d25"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "9b95805f-316d-435e-a4e3-874834225d25",
    "createTime" : 1.620135226920058E9,
    "updateTime" : 1.620135241920041E9,
    "status" : "CONVERTING",
    "ownerId" : "6562719b-d2db-4138-b536-13d68f8fdaac",
    "contentType" : "PDF",
    "title" : "job 7"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/526b1d12-0c49-48b8-852e-66603ad64410"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "526b1d12-0c49-48b8-852e-66603ad64410",
    "createTime" : 1.620135226920108E9,
    "updateTime" : 1.620135241920089E9,
    "status" : "CONVERTING",
    "ownerId" : "d1c1d0bb-ec5b-47f3-a95b-38647f12aa73",
    "contentType" : "PDF",
    "title" : "job 8"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/87047291-7297-48b6-8c17-2c8a8fc0f555"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "87047291-7297-48b6-8c17-2c8a8fc0f555",
    "createTime" : 1.620135226920137E9,
    "updateTime" : 1.620135241920128E9,
    "status" : "CONVERTING",
    "ownerId" : "910ca935-d279-45cc-9204-9f0daf4fab4a",
    "contentType" : "PDF",
    "title" : "job 9"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/fda948d8-5e98-4736-8f5c-6dcc0dd0d130"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "fda948d8-5e98-4736-8f5c-6dcc0dd0d130",
    "createTime" : 1.620135226920172E9,
    "updateTime" : 1.620135241920155E9,
    "status" : "CONVERTING",
    "ownerId" : "d1c93078-3d0e-4d32-9b3b-e1eadcfc6e28",
    "contentType" : "PDF",
    "title" : "job 10"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/3c653228-a331-474d-a7cb-ed17431b3be9"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "3c653228-a331-474d-a7cb-ed17431b3be9",
    "createTime" : 1.620135226920208E9,
    "updateTime" : 1.620135241920191E9,
    "status" : "CONVERTING",
    "ownerId" : "5736d63e-0926-4823-8bca-816c0e7ae17e",
    "contentType" : "PDF",
    "title" : "job 11"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/jobs/bd45d1a7-e8dc-4432-9218-d11ca2e71292"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/bf0687b4-dbc1-4e8f-8c4a-a0bd5b114a82/printers/6cf7e788-6b79-444d-8bff-332baac5f68a/queues/cb2259fe-a7be-4b9a-8c56-26acc6229395"
      }
    },
    "id" : "bd45d1a7-e8dc-4432-9218-d11ca2e71292",
    "createTime" : 1.620135226920259E9,
    "updateTime" : 1.620135241920239E9,
    "status" : "CONVERTING",
    "ownerId" : "c6a17ce6-b076-4de6-826b-a1429b1c2c67",
    "contentType" : "PDF",
    "title" : "job 12"
  } ],
  "page" : {
    "size" : 10,
    "totalElements" : 13,
    "totalPages" : 2,
    "number" : 0
  }
}

Job Example

Request:

GET /cloudprint/tenants/3f9b85be-c674-413e-bc62-a55245287403/jobs/da09d688-e19d-465b-a304-0727b20ee98e HTTP/1.1
Authorization: Bearer 997c449a-6c0d-4b69-9db3-e04c35cefc9d
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: bunfNmMk
Content-Type: application/json
Content-Length: 914

{
  "tenantId" : "3f9b85be-c674-413e-bc62-a55245287403",
  "sortOrder" : null,
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/3f9b85be-c674-413e-bc62-a55245287403/jobs/da09d688-e19d-465b-a304-0727b20ee98e"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/3f9b85be-c674-413e-bc62-a55245287403/printers/f2ebf4db-2fa3-4559-aabf-022349b46bf4/queues/36415960-94c2-4c1c-bfb6-35fcd0660722"
      }
    },
    "id" : "da09d688-e19d-465b-a304-0727b20ee98e",
    "createTime" : 1.620135227931073E9,
    "updateTime" : 1.620135242931048E9,
    "status" : "CONVERTED",
    "ownerId" : "19ffff85-7405-4c90-9af6-6550539adb06",
    "contentType" : "PDF",
    "title" : "job name"
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Delete Example

Request:

POST /cloudprint/tenants/8d9ac7f4-61bc-4703-8f16-520441cb5127/jobs/4d439091-79a9-437c-9c16-6f7203bf42c8/delete HTTP/1.1
Authorization: Bearer 9adcce45-d7b2-4172-9788-6a8995bf6a50
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: ncQA9qvt
Content-Type: application/json
Content-Length: 124

{
  "success" : true,
  "message" : "The print job with id 4d439091-79a9-437c-9c16-6f7203bf42c8 was deleted successfully."
}

Printer List Example

Request:

GET /cloudprint/tenants/e673591f-1b35-405b-a18e-19ae601ad757/printers?page=0&pageSize=100 HTTP/1.1
Authorization: Bearer 65706ba7-c614-4dde-86ba-e0e74fa80c97
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: k4Tc5Jdw
Content-Type: application/json
Content-Length: 3122

{
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/e673591f-1b35-405b-a18e-19ae601ad757/printers?page=1&pageSize=100{&query}",
      "templated" : true
    },
    "prev" : {
      "href" : "https://api.printix.net/cloudprint/tenants/e673591f-1b35-405b-a18e-19ae601ad757/printers?page=0&pageSize=100{&query}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "printers" : [ {
    "id" : "b0c5425b-6980-45c8-8b4a-926c52a3830c",
    "name" : "Queue",
    "capabilities" : {
      "printer" : {
        "media_size" : {
          "option" : [ {
            "heightMicrons" : 297000,
            "widthMicrons" : 210000,
            "name" : "ISO_A4",
            "isContinuousFeed" : false,
            "isDefault" : false
          }, {
            "heightMicrons" : 420000,
            "widthMicrons" : 297000,
            "name" : "ISO_A3",
            "isContinuousFeed" : false,
            "isDefault" : false
          }, {
            "heightMicrons" : 279400,
            "widthMicrons" : 215900,
            "name" : "NA_LETTER",
            "isContinuousFeed" : false,
            "isDefault" : false
          }, {
            "heightMicrons" : 355600,
            "widthMicrons" : 215900,
            "name" : "NA_LEGAL",
            "isContinuousFeed" : false,
            "isDefault" : false
          } ]
        },
        "supported_content_type" : [ {
          "content_type" : "application/pdf",
          "min_version" : "1.0"
        } ],
        "copies" : {
          "defaultz" : 1,
          "max" : 100
        },
        "color" : {
          "option" : [ {
            "type" : "STANDARD_COLOR",
            "default" : true
          }, {
            "type" : "STANDARD_MONOCHROME",
            "default" : false
          } ]
        },
        "vendor_capability" : [ {
          "id" : "printLater",
          "display_name" : "Print Later",
          "type" : "TYPED_VALUE",
          "display_name_localized" : [ {
            "locale" : "EN",
            "value" : "Print Later"
          } ],
          "typed_value_cap" : {
            "value_type" : "BOOLEAN",
            "default" : "false"
          }
        } ]
      }
    },
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/e673591f-1b35-405b-a18e-19ae601ad757/printers/17c0dfc0-2aba-441f-b79a-52636b2ce331/queues/b0c5425b-6980-45c8-8b4a-926c52a3830c"
      },
      "submit" : {
        "href" : "https://api.printix.net/cloudprint/tenants/e673591f-1b35-405b-a18e-19ae601ad757/printers/17c0dfc0-2aba-441f-b79a-52636b2ce331/queues/b0c5425b-6980-45c8-8b4a-926c52a3830c/submit?title={title}{&user,PDL}",
        "templated" : true
      },
      "jobs" : {
        "href" : "https://api.printix.net/cloudprint/tenants/e673591f-1b35-405b-a18e-19ae601ad757/printers/17c0dfc0-2aba-441f-b79a-52636b2ce331/queues/b0c5425b-6980-45c8-8b4a-926c52a3830c/jobs{?page,pageSize}",
        "templated" : true
      }
    }
  } ],
  "page" : {
    "size" : 100,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1
  }
}

Printer Info Example

Request:

GET /cloudprint/tenants/8a20ed5d-96a5-444b-a2c9-b8101114ad5e/printers/ceee20a0-68c8-4439-8761-2ba81c4f903d/queues/0309990b-9096-456c-82ee-34a011643d85?page=0 HTTP/1.1
Authorization: Bearer effa6b29-9174-49b8-8b9f-9693e6aab0d4
Accept: application/json
Host: api.printix.net

Response:

HTTP/1.1 200 OK
X-Printix-Request-ID: unmatched
X-Printix-Trace-ID: VXVH4cn3
Content-Type: application/json
Content-Length: 2715

{
  "success" : true,
  "message" : "OK",
  "printers" : [ {
    "id" : "0309990b-9096-456c-82ee-34a011643d85",
    "capabilities" : {
      "printer" : {
        "media_size" : {
          "option" : [ {
            "heightMicrons" : 297000,
            "widthMicrons" : 210000,
            "name" : "ISO_A4",
            "isContinuousFeed" : false,
            "isDefault" : false
          }, {
            "heightMicrons" : 420000,
            "widthMicrons" : 297000,
            "name" : "ISO_A3",
            "isContinuousFeed" : false,
            "isDefault" : false
          }, {
            "heightMicrons" : 279400,
            "widthMicrons" : 215900,
            "name" : "NA_LETTER",
            "isContinuousFeed" : false,
            "isDefault" : false
          }, {
            "heightMicrons" : 355600,
            "widthMicrons" : 215900,
            "name" : "NA_LEGAL",
            "isContinuousFeed" : false,
            "isDefault" : false
          } ]
        },
        "supported_content_type" : [ {
          "content_type" : "application/pdf",
          "min_version" : "1.0"
        } ],
        "copies" : {
          "defaultz" : 1,
          "max" : 100
        },
        "color" : {
          "option" : [ {
            "type" : "STANDARD_COLOR",
            "default" : true
          }, {
            "type" : "STANDARD_MONOCHROME",
            "default" : false
          } ]
        },
        "vendor_capability" : [ {
          "id" : "printLater",
          "display_name" : "Print Later",
          "type" : "TYPED_VALUE",
          "display_name_localized" : [ {
            "locale" : "EN",
            "value" : "Print Later"
          } ],
          "typed_value_cap" : {
            "value_type" : "BOOLEAN",
            "default" : "false"
          }
        } ]
      }
    },
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/8a20ed5d-96a5-444b-a2c9-b8101114ad5e/printers/ceee20a0-68c8-4439-8761-2ba81c4f903d/queues/0309990b-9096-456c-82ee-34a011643d85"
      },
      "submit" : {
        "href" : "https://api.printix.net/cloudprint/tenants/8a20ed5d-96a5-444b-a2c9-b8101114ad5e/printers/ceee20a0-68c8-4439-8761-2ba81c4f903d/queues/0309990b-9096-456c-82ee-34a011643d85/submit?title={title}{&user,PDL}",
        "templated" : true
      },
      "jobs" : {
        "href" : "https://api.printix.net/cloudprint/tenants/8a20ed5d-96a5-444b-a2c9-b8101114ad5e/printers/ceee20a0-68c8-4439-8761-2ba81c4f903d/queues/0309990b-9096-456c-82ee-34a011643d85/jobs{?page,pageSize}",
        "templated" : true
      }
    }
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}