Changelog

2023-07-12

2023-05-24

  • Added the /changeOwner endpoint which allows users to modify the print job’s owner by providing the email address of the job’s new owner. See Change owner.

2021-07-30

2021-03-26

  • Better documented the use for the PDL parameter, see Submit a job

2021-03-22

  • Added an option in the request body of the New Submit method, to allow the user to specify if a job should be scaled.

2021-03-01

  • Added an alternative version of the /submit endpoint, 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 its 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 entry-point (see root request). All successful responses contain 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 specification, 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.

There can only be one set of Cloud Print API credentials in use at one time: if you create new ones later on as described below, your previous ones will be invalidated.
Be aware that, because the API credentials are tied to an API "user" in our system, the Cloud Print API will not work if the Secure Print configuration on your tenant is set to "All users must print securely".
If you wish to use the Cloud Print API, please use Groups to set what users must print securely.
Refer to this section of the Printix Administrator manual for more information

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 endpoints, with the same rate of 100 requests per minute per user. Given these values, users should expect 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 endpoint takes no request parameters and returns a list of links to accessible tenants.

Code Example Root Example

Submit a job

The /submit endpoint is used to submit a document for printing.

This endpoint 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 that 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 endpoint.

This endpoint 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 username, so the parameter may set to an arbitrary name.
In the case of integration with third-party solutions however, the user parameter should be set to the same username used in the third-party software. It is important to use the exact same formatting in the user parameter 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 PCL5. 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

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

Title of the print job.

user

Name of the user that is printing. This parameter is used for integration with third-party print solutions.

PDL

Optional. 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 tenant’s preferred cloud storage service, to which the document to be printed should be uploaded.

  • A uploadCompleted link to be used with the /completeUpload endpoint.

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

Path Type Description

job.id

String

ID of the generated print job.

job.createTime

Number

Unix timestamp for when the job was created.

job.updateTime

Number

Unix timestamp of when the job was last updated (for new jobs, this is the same as createTime).

job.status

String

Current state of the job.

job.ownerId

String

ID of the Printix user who is the owner of the job.

job.contentType

String

Content type of the uploaded document.

job.title

String

Title of the print job that was specified in the parameter of the /submit request.

_links.changeOwner

Object

Link to be used for changing the job’s owner.

_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 HTTP PUT request.

Error handling

This endpoint 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

An alternative version of the /submit endpoint exist, allowing users to specify the following properties for the print job they are submitting:

  • Color

  • Duplex

  • Page orientation

  • Copies

  • Paper size

  • Scaling

  • Job releasing mode (immediately, later)

For more details on these, see the Request body fields table below, as well as the example.

This newer version of the endpoint is on the same URL as the original version of the /submit endpoint. To use this new version, simply follow these two steps:
- Add a version header to your request and set it to the value 1.1.
- Change the body of an existing request, or create a new request body; In both cases,
the request body should have the same fields and formatting shown in Submit Example (version 1.1).

The Request body fields table further below shows what values can be set for each field.

Request parameters

Parameter Description

title

The title of the print job

user

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

PDL

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

releaseImmediately

Optional. A boolean parameter indicating whether the print job should be released on the printer immediately after the uploadCompleted link was invoked. Default: "true"

Refer to the Submit a job section for more information on request parameters.

Request body fields

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,

Error handling

This endpoint 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 (version 1.1)

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 Cloud Print API endpoints: Azure and/or Google will handle the authentication for this particular request.

GCP and Azure will not recognize Cloud Print API tokens and will return a 403 error if the user tries to send such token 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 endpoint 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. Printing starts automatically only if the releaseImmediately=true parameter was specified in the earlier /submit request.

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

Error handling

This endpoint 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 endpoint (plural) is used to retrieve a list of jobs for the authenticated user. There are two ways to call the /jobs endpoint, 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 endpoint 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 endpoint take the optional parameters outlined below, except for the sortOrder parameter
Parameter Description

query

A parameter used to look for printers whose name contains a specific sequence of characters

page

An integer value that indicates which page of the results to display if the list of printers is split over multiple pages

pageSize

An integer value that indicates how many printers can fit on a page

sortOrder

An optional parameter that indicates how the returned jobs should be sorted

The sortOrder parameter is only available when listing all jobs on a tenant (i.e., the first example endpoint given above) and can be used to set what propriety is used to sort the returned jobs.

The sortOrder parameter can be set to one of the following values:

Value

Description

CREATE_TIME

Sort jobs in ascending order of submission.

CREATE_TIME_DESC

Sort jobs in descending order of submission. (this is the default if the parameter is not set explicitly)

STATUS

Sort jobs in ascending order of status.

STATUS_DESC

Sort jobs in descending order of status.

TITLE

Sort jobs in ascending alphabetical order of title

TITLE_DESC

Sort jobs in descending alphabetical order of title.

Response

Both versions of the endpoint return a boolean success indicator and a paged list of jobs.

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

Path Type Description

tenantId

String

ID of the tenant.

sortOrder

String

If set as a request parameter, it describes on what field the returned jobs should be sorted.

jobs[]._links

Object

A JSON Object containing API links to a specific job, as well as the printer that it was sent to.

jobs[].id

String

ID of the generated print job.

jobs[].createTime

Number

Unix timestamp for when the job was created.

jobs[].updateTime

Number

Unix timestamp for when the job was last updated (for new jobs, this is the same as createTime).

jobs[].status

String

Current state of the job.

jobs[].ownerId

String

ID of the Printix user who is the owner of the job.

jobs[].contentType

String

Content type of the uploaded document.

jobs[].title

String

Title of the print job that was specified in the parameter of the /submit request.

Error handling

This endpoint 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 endpoint (singular) is used to retrieve a single job, for example to check its status after it has been submitted. This endpoint takes no parameters, it returns a boolean success indicator and information for the job that was queried.

Error handling

This endpoint 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 endpoint 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 endpoint takes no parameters, it returns a boolean success indicator and a message confirming that the job has been deleted.

Error handling

This endpoint 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 endpoint (singular) can be used to receive all fields of a specified printer, including its capabilities. It takes no request parameters and returns a boolean success indicator with 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:

Path Type Description

printers[].id

String

ID of the returned printer.

printers[].name

String

Name of the returned printer.

printers[].connectionStatus

String

Connection status of the returned printer: can be either ONLINE, OFFLINE, or UNKNOWN when the state of the printer cannot be determined.

printers[].type

String

Type of the returned printer.

printers[].printerSignId

String

Sign ID of the associated printer. Note that this is associated with a single printer, not a queue, so the value of the field may not be unique if multiple queues exist for a single printer.

printers[].location

String

The location of the printer (if set). This is reflected, and can be modified, in the Printix Administrator

printers[].model

String

The Printer model, as detected by Printix

printers[].vendor

String

The Printer vendor, as detected by Printix

printers[].capabilities.printer.media_size.option[]

Array

A list of supported paper formats on the printer.

printers[].capabilities.printer.supported_content_type[]

Array

A list of content types/print formats supported by the printer. This is always PDF by default.

printers[].capabilities.printer.copies

Object

(DEPRECATED) Describes the default and maximum number of copies supported by the printer.

printers[].capabilities.printer.color.option[]

Array

A list of color options supported by the printer.

printers[].capabilities.printer.vendor_capability[]

Array

A list of objects describing whether the printer supports releasing print jobs from the cloud, and various localization options.

printers[]._links

Object

A JSON object containing API links for this printer, which the user can use to query information about this specific printer, submit a job on this printer, or see the jobs on it.

Error handling

This endpoint 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 endpoint (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:

Parameter Description

query

A parameter used to look for printers whose name contains a specific sequence of characters

page

An integer value that indicates which page of the results to display if the list of printers is split over multiple pages

pageSize

An integer value that indicates how many printers can fit on a page

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.

Path Type Description

printers[].id

String

ID of the returned printer.

printers[].name

String

Name of the returned printer.

printers[].connectionStatus

String

Connection Status of the returned printer: can be either ONLINE, OFFLINE, or UNKNOWN when the state of the printer cannot be determined.

printers[].printerSignId

String

Sign ID of the associated printer. Note that this is associated with a single printer, not a queue, so the value of the field may not be unique if multiple queues exist for a single printer.

printers[].location

String

The location of the printer (if set). This is reflected, and can be modified, in the Printix Administrator

printers[].model

String

The Printer model, as detected by Printix

printers[].vendor

String

The Printer vendor, as detected by Printix

printers[].capabilities.printer.media_size.option[]

Array

A list of supported paper formats on the printer.

printers[].capabilities.printer.supported_content_type[]

Array

A list of content types/print formats supported by the printer. This is always PDF by default.

printers[].capabilities.printer.copies

Object

(DEPRECATED) Describes the default and maximum number of copies supported by the printer.

printers[].capabilities.printer.color.option[]

Array

A list of color options supported by the printer.

printers[].capabilities.printer.vendor_capability[]

Array

A list of objects describing whether the printer supports releasing print jobs from the cloud, and various localization options.

printers[]._links

Object

A JSON object containing API links for this printer, which the user can use to query information about this specific printer, submit a job on this printer, or see the jobs on it.

Error handling

This endpoint 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

Change owner

The /changeOwner endpoint can be used to modify which user is the owner of the print job. By default, all jobs created through the Cloud Print API have a hidden Cloud Print API user assigned. These hidden user accounts cannot log in to the devices. They are authorized only to access the Cloud Print API using the client ID and client secret pairs. Using this endpoint, API users can create print jobs for "real" users who have their own Azure/Google/etc. identity. These end-users can release their own print jobs at the devices later using secure print if the job was submitted with the releaseImmediately=false setting.

After the job’s owner changed, the job will disappear from the list returned by the Retrieve Jobs operation since the job no longer belongs to the original Cloud Print API user.

Due to security reasons, it’s possible to change the owner only for those jobs which were created through the Cloud Print API.

Request parameters

This request can take the following parameter:

Parameter Description

userEmail

The email address of the job’s new owner. This user must be registered and validated in the same tenant as the job was created.
This parameter can be passed through query string parameter or in the request body if the Content-Type HTTP header is "application/x-www-form-urlencoded".

Response

This request returns a boolean success indicator and information for the job that was modified.

Error handling

This endpoint 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: Change Owner Example

Create User

The /users/create endpoint can be used to create a new guest user.

Request parameters

This endpoint does not take any request parameters. Properties for the user can be specified in the request body. For further details, see the Request body fields table below, as well as Create User Example.

Request body fields

Parameter Description

email

Email address of the user.

fullName

Full name of the user.

role

Role of the user. Currently, only the GUEST_USER role is supported in this request.

pin

An optional, 4-digit PIN code for the user, which can be used to sign in at the printer.
If not specified, the system generates a random PIN code.

password

An optional password for the user. If not specified, the system generates a random password.
The password must be at least 6 characters long and contain both uppercase letters, lowercase letters, and digits.

expirationTimestamp

An optional timestamp, which sets the end of the validity period of the user. When it expires, the user is scheduled for automatic deletion in the next 24 hours.
Format: yyyy.MM.dd HH:mm

sendWelcomeEmail

Sets whether a welcome email should be sent to the user. Currently, only the default welcome email can be sent regardless of the selected value.
Possible values are true or false.

sendExpirationEmail

Sets whether an expiration email should be sent to the user.
Possible values are true or false.

Response

This request returns a boolean success indicator, alongside the created user with its metadata.

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

Path Type Description

users[].id

String

ID of the created user.

users[].email

String

Email address of the user.

users[].fullName

String

Full name of the user.

users[].role

String

Role of the user. Currently, only the GUEST_USER role is supported in this request.

users[].idCode

String

6-digit ID code of the user, which can be used to sign in at the printer.

users[].pin

String

4-digit PIN code of the user, which can be used to sign in at the printer.

users[].password

String

Password of the user. If the user already existed in Printix with the specified email address and now only a new access has been granted to this tenant, the existing password is not changed and not returned.

users[].expirationTimestamp

String

End of the validity period of the user. When it expires, the user is scheduled for automatic deletion in the next 24 hours.

users[].sendWelcomeEmail

Boolean

Indicates whether a welcome email is sent to the user.

users[].sendExpirationEmail

Boolean

Indicates whether an expiration email is sent to the user.

users[].welcomeEmailContent

String

The content of the welcome email if it was specified in the request.

Error handling

This endpoint 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: Create User Example

List Users

The /users endpoint (plural) can be used to retrieve a list of guest users.

Request parameters

This request can take the following optional parameters:

Parameter Description

query

A parameter used to look for users whose name or email address contains a specific sequence of characters

page

An integer value that indicates which page of the results to display if the list of users is split over multiple pages

pageSize

An integer value that indicates how many users can fit on a page

Response

This request returns a boolean success indicator and a paged list of users.

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

Path Type Description

users[].id

String

ID of the user.

users[].fullName

String

Full name of the user.

users[].email

String

Email address of the user

users[].role

String

Role of the user in Printix. Currently, only the GUEST_USER role is supported in this request.

users[].expirationTimestamp

String

End of the validity period of the user. When it expires, the user is scheduled for automatic deletion.

Error handling

This endpoint 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: User List Example

Delete User

The /users/{userId}/delete endpoint is used to delete a guest user.

This endpoint takes only the userId parameter in the URI path. It returns a boolean success indicator and a message confirming that the user has been deleted.

Error handling

This endpoint returns a false boolean success indicator in all failure scenarios, as well as a 404 error if the user to delete could not be found. A 500 error is returned if other errors occur. In both cases, the response body contains an error description and an internal error ID for troubleshooting.

Code Example: Delete User Example

Code Examples

Root Example

Request:

GET /cloudprint HTTP/1.1
Authorization: Bearer f126e0d8-09aa-456a-a1ae-c673d9c11c64
Accept: application/json
Host: api.printix.net

Response:

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

{
  "_links" : {
    "acme.printix.net" : {
      "href" : "https://api.printix.net/cloudprint/tenants/76b2f246-ffdf-4a5d-9b01-0407ddb1bb7d/printers?page=0&pageSize=10{&query,network,site}",
      "templated" : true
    }
  }
}

Submit Example

Request:

POST /cloudprint/tenants/f4461ff9-d5a9-44d4-8416-e5338c85d413/printers/44acd5dc-68a5-4dcb-9654-f88772eeec7a/queues/ed6f6de8-27e0-4ba6-9f30-b9469fe0e6cc/submit?title=a+title&user=John+Doe HTTP/1.1
Content-Type: application/json
Authorization: Bearer a97dae1e-069b-4b2a-b7d2-9d5ac490ea1d
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: PMhH5TRz
Content-Type: application/json
Content-Length: 1806

{
  "job" : {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/f4461ff9-d5a9-44d4-8416-e5338c85d413/jobs/1ff22998-2365-4d87-a314-2738e4e87cdf"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/f4461ff9-d5a9-44d4-8416-e5338c85d413/printers/44acd5dc-68a5-4dcb-9654-f88772eeec7a/queues/ed6f6de8-27e0-4ba6-9f30-b9469fe0e6cc"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/f4461ff9-d5a9-44d4-8416-e5338c85d413/jobs/1ff22998-2365-4d87-a314-2738e4e87cdf/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "1ff22998-2365-4d87-a314-2738e4e87cdf",
    "createTime" : 1.7113769266095114E9,
    "updateTime" : 1.711376926626161E9,
    "status" : "AWAIT_PRINT",
    "ownerId" : "2705f2f0-259a-4090-878c-e469f8a90c15",
    "contentType" : "PDF",
    "title" : "a title"
  },
  "_links" : {
    "uploadCompleted" : {
      "href" : "https://api.printix.net/cloudprint/tenants/f4461ff9-d5a9-44d4-8416-e5338c85d413/jobs/1ff22998-2365-4d87-a314-2738e4e87cdf/completeUpload"
    },
    "changeOwner" : {
      "href" : "https://api.printix.net/cloudprint/tenants/f4461ff9-d5a9-44d4-8416-e5338c85d413/jobs/1ff22998-2365-4d87-a314-2738e4e87cdf/changeOwner?userEmail={userEmail}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "uploadLinks" : [ {
    "url" : "https://printixjobs.blob.core.windows.net/9aab9505-c84f-4dba-814f-d710b7c6d089/printix-jobs-file-upload/1ff22998-2365-4d87-a314-2738e4e87cdf?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/57ab9c92-2b2d-4406-82a1-9828d785a416/printers/d488f710-b0eb-412b-bd08-c3883041db7f/queues/838c7e9b-f7e3-46e3-a05e-2e10f30ac290/submit?title=a+title&user=John+Doe HTTP/1.1
Content-Type: application/json
Authorization: Bearer cd7e1892-3edc-4c8f-968d-89e1c02b1001
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: VFauWr5V
Content-Type: application/json
Content-Length: 1807

{
  "job" : {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/57ab9c92-2b2d-4406-82a1-9828d785a416/jobs/5ffca4a2-2567-460e-b433-ad59ceeb2b22"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/57ab9c92-2b2d-4406-82a1-9828d785a416/printers/d488f710-b0eb-412b-bd08-c3883041db7f/queues/838c7e9b-f7e3-46e3-a05e-2e10f30ac290"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/57ab9c92-2b2d-4406-82a1-9828d785a416/jobs/5ffca4a2-2567-460e-b433-ad59ceeb2b22/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "5ffca4a2-2567-460e-b433-ad59ceeb2b22",
    "createTime" : 1.7113769272100534E9,
    "updateTime" : 1.7113769272126572E9,
    "status" : "AWAIT_PRINT",
    "ownerId" : "b201c1a7-318b-4a1e-80e0-3f5cfd88d5f9",
    "contentType" : "PDF",
    "title" : "a title"
  },
  "_links" : {
    "uploadCompleted" : {
      "href" : "https://api.printix.net/cloudprint/tenants/57ab9c92-2b2d-4406-82a1-9828d785a416/jobs/5ffca4a2-2567-460e-b433-ad59ceeb2b22/completeUpload"
    },
    "changeOwner" : {
      "href" : "https://api.printix.net/cloudprint/tenants/57ab9c92-2b2d-4406-82a1-9828d785a416/jobs/5ffca4a2-2567-460e-b433-ad59ceeb2b22/changeOwner?userEmail={userEmail}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "uploadLinks" : [ {
    "url" : "https://printixjobs.blob.core.windows.net/9aab9505-c84f-4dba-814f-d710b7c6d089/printix-jobs-file-upload/5ffca4a2-2567-460e-b433-ad59ceeb2b22?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/e3bcd5fe-eb34-4fd3-8ed9-3ae4d4779ce3/jobs/84c3a7d9-0c04-4d89-a70b-25f8f045f99a/completeUpload HTTP/1.1
Authorization: Bearer 9749dff2-d892-4e4a-8036-e8344dd7ca88
Accept: application/json
Host: api.printix.net

Response:

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

{
  "tenantId" : "e3bcd5fe-eb34-4fd3-8ed9-3ae4d4779ce3",
  "sortOrder" : null,
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/e3bcd5fe-eb34-4fd3-8ed9-3ae4d4779ce3/jobs/84c3a7d9-0c04-4d89-a70b-25f8f045f99a"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/e3bcd5fe-eb34-4fd3-8ed9-3ae4d4779ce3/printers/05f80ade-6215-4912-840a-b40c59674bac/queues/61f65bf5-2f37-4772-8877-451da5bdedcf"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/e3bcd5fe-eb34-4fd3-8ed9-3ae4d4779ce3/jobs/84c3a7d9-0c04-4d89-a70b-25f8f045f99a/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "84c3a7d9-0c04-4d89-a70b-25f8f045f99a",
    "createTime" : 1.7113769115451865E9,
    "updateTime" : 1.7113769265451615E9,
    "status" : "CONVERTING",
    "ownerId" : "335e1837-4b1b-4a70-aa21-2f78be9d8f6e",
    "contentType" : "PDF",
    "title" : "job name"
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Job List Example

Request:

GET /cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs?page=0&pageSize=10 HTTP/1.1
Authorization: Bearer 2eb4447f-6314-40ba-97a2-67e33b448ffa
Accept: application/json
Host: api.printix.net

Response:

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

{
  "tenantId" : "2b19a777-5f11-4f3b-8421-07f06b8facb1",
  "sortOrder" : null,
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs?page=0&pageSize=10{&sortorder}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs?page=1&pageSize=10{&sortorder}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/05fddf04-f5de-441e-a28f-ddc279d7b6f3"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/05fddf04-f5de-441e-a28f-ddc279d7b6f3/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "05fddf04-f5de-441e-a28f-ddc279d7b6f3",
    "createTime" : 1.7113769119456935E9,
    "updateTime" : 1.7113769269456546E9,
    "status" : "CONVERTING",
    "ownerId" : "d0956a5c-6fda-43e2-999f-ce69f0831594",
    "contentType" : "PDF",
    "title" : "job 0"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/f929c13d-ce61-409f-9e01-c966822ecbcf"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/f929c13d-ce61-409f-9e01-c966822ecbcf/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "f929c13d-ce61-409f-9e01-c966822ecbcf",
    "createTime" : 1.711376911945724E9,
    "updateTime" : 1.7113769269457123E9,
    "status" : "CONVERTING",
    "ownerId" : "a088f4d9-f795-4a07-8928-45ab6b97d6db",
    "contentType" : "PDF",
    "title" : "job 1"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/114bb761-1595-4f8e-938c-f2d0d4b4e9cc"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/114bb761-1595-4f8e-938c-f2d0d4b4e9cc/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "114bb761-1595-4f8e-938c-f2d0d4b4e9cc",
    "createTime" : 1.711376911945741E9,
    "updateTime" : 1.7113769269457302E9,
    "status" : "CONVERTING",
    "ownerId" : "da319478-04e2-4032-9cf9-6ad96c6ddfdf",
    "contentType" : "PDF",
    "title" : "job 2"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/75eacf42-88a1-4957-84fd-f2a455aaedff"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/75eacf42-88a1-4957-84fd-f2a455aaedff/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "75eacf42-88a1-4957-84fd-f2a455aaedff",
    "createTime" : 1.7113769119457624E9,
    "updateTime" : 1.7113769269457521E9,
    "status" : "CONVERTING",
    "ownerId" : "f0e2a784-cace-4ced-b7b2-4055e81ce826",
    "contentType" : "PDF",
    "title" : "job 3"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/7e7391bd-3101-4c5f-9179-dfa5498b3755"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/7e7391bd-3101-4c5f-9179-dfa5498b3755/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "7e7391bd-3101-4c5f-9179-dfa5498b3755",
    "createTime" : 1.7113769119457786E9,
    "updateTime" : 1.7113769269457734E9,
    "status" : "CONVERTING",
    "ownerId" : "2c1599b3-4acf-47ca-ab3a-fd706cc332df",
    "contentType" : "PDF",
    "title" : "job 4"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/b4a9d8f2-9da4-4f1c-9147-a9487736f0c1"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/b4a9d8f2-9da4-4f1c-9147-a9487736f0c1/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "b4a9d8f2-9da4-4f1c-9147-a9487736f0c1",
    "createTime" : 1.7113769119457996E9,
    "updateTime" : 1.7113769269457893E9,
    "status" : "CONVERTING",
    "ownerId" : "a6754ccb-6004-49ba-8616-83d289c67f77",
    "contentType" : "PDF",
    "title" : "job 5"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/8e54e8ee-562a-4487-bf5e-4176a89db336"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/8e54e8ee-562a-4487-bf5e-4176a89db336/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "8e54e8ee-562a-4487-bf5e-4176a89db336",
    "createTime" : 1.7113769119458208E9,
    "updateTime" : 1.7113769269458108E9,
    "status" : "CONVERTING",
    "ownerId" : "841c81d7-c07b-4ca5-bd8e-42779e5fbaca",
    "contentType" : "PDF",
    "title" : "job 6"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/e28058a2-8553-46f1-8c3a-5c3783189b16"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/e28058a2-8553-46f1-8c3a-5c3783189b16/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "e28058a2-8553-46f1-8c3a-5c3783189b16",
    "createTime" : 1.711376911945837E9,
    "updateTime" : 1.7113769269458268E9,
    "status" : "CONVERTING",
    "ownerId" : "4aa14410-4187-4564-af5a-fb9358737a5e",
    "contentType" : "PDF",
    "title" : "job 7"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/ce32e2a3-59e2-47e2-9196-8dc6a9ed50b4"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/ce32e2a3-59e2-47e2-9196-8dc6a9ed50b4/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "ce32e2a3-59e2-47e2-9196-8dc6a9ed50b4",
    "createTime" : 1.711376911945862E9,
    "updateTime" : 1.711376926945848E9,
    "status" : "CONVERTING",
    "ownerId" : "023126b5-4209-4da6-87ca-999c4aa18ce5",
    "contentType" : "PDF",
    "title" : "job 8"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/cd175a2a-49eb-4a25-bc91-72cf9cae7c8c"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/cd175a2a-49eb-4a25-bc91-72cf9cae7c8c/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "cd175a2a-49eb-4a25-bc91-72cf9cae7c8c",
    "createTime" : 1.7113769119458828E9,
    "updateTime" : 1.711376926945877E9,
    "status" : "CONVERTING",
    "ownerId" : "24580c01-54b2-44ec-9f46-36081e299f7e",
    "contentType" : "PDF",
    "title" : "job 9"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/f6397dc7-e9dc-4479-a6d6-a00870be1f7d"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/f6397dc7-e9dc-4479-a6d6-a00870be1f7d/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "f6397dc7-e9dc-4479-a6d6-a00870be1f7d",
    "createTime" : 1.7113769119459047E9,
    "updateTime" : 1.711376926945894E9,
    "status" : "CONVERTING",
    "ownerId" : "25ce52da-78b8-4473-bc42-6f88459071bd",
    "contentType" : "PDF",
    "title" : "job 10"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/d360282a-4461-40e4-81d7-dd7e90fdda43"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/d360282a-4461-40e4-81d7-dd7e90fdda43/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "d360282a-4461-40e4-81d7-dd7e90fdda43",
    "createTime" : 1.7113769119459257E9,
    "updateTime" : 1.7113769269459157E9,
    "status" : "CONVERTING",
    "ownerId" : "a9d71a0b-45de-4d05-a7b5-2496c7bb8154",
    "contentType" : "PDF",
    "title" : "job 11"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/e9b31b37-96c8-4c9c-8f7c-74c7a73c5f57"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/printers/16eb3f99-ca2b-4f7f-9b88-00b0de79cc4f/queues/29ee654b-6879-4678-83df-6c7bc2200d37"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/2b19a777-5f11-4f3b-8421-07f06b8facb1/jobs/e9b31b37-96c8-4c9c-8f7c-74c7a73c5f57/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "e9b31b37-96c8-4c9c-8f7c-74c7a73c5f57",
    "createTime" : 1.7113769119459543E9,
    "updateTime" : 1.7113769269459314E9,
    "status" : "CONVERTING",
    "ownerId" : "824ee0b4-b53e-4dcd-a1ab-637471cbdf1f",
    "contentType" : "PDF",
    "title" : "job 12"
  } ],
  "page" : {
    "size" : 10,
    "totalElements" : 13,
    "totalPages" : 2,
    "number" : 0
  }
}

Printer Job List Example

Request:

GET /cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804/jobs?page=0&pageSize=10 HTTP/1.1
Authorization: Bearer ee27c63a-d116-4a5f-9aaf-124f3fa872b2
Accept: application/json
Host: api.printix.net

Response:

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

{
  "tenantId" : "69deae0b-15b2-43f3-9e1f-e65d66061fe1",
  "sortOrder" : null,
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804/jobs?page=0&pageSize=10"
    },
    "next" : {
      "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804/jobs?page=1&pageSize=10"
    }
  },
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/f87184a1-d9ca-4208-9ca2-23db4a0c6beb"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/f87184a1-d9ca-4208-9ca2-23db4a0c6beb/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "f87184a1-d9ca-4208-9ca2-23db4a0c6beb",
    "createTime" : 1.7113769114527779E9,
    "updateTime" : 1.7113769264518993E9,
    "status" : "CONVERTING",
    "ownerId" : "a22a7dc7-51f0-4d9d-b2ff-4ccac9e6bcc2",
    "contentType" : "PDF",
    "title" : "job 0"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/d1794b98-7a56-4ecf-8546-b01a5ab2947e"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/d1794b98-7a56-4ecf-8546-b01a5ab2947e/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "d1794b98-7a56-4ecf-8546-b01a5ab2947e",
    "createTime" : 1.7113769114534154E9,
    "updateTime" : 1.7113769264533987E9,
    "status" : "CONVERTING",
    "ownerId" : "41e19532-bae1-4b67-b78b-3990683daa18",
    "contentType" : "PDF",
    "title" : "job 1"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/a4abed57-0fda-4b17-bba4-7d1ea014e7c7"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/a4abed57-0fda-4b17-bba4-7d1ea014e7c7/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "a4abed57-0fda-4b17-bba4-7d1ea014e7c7",
    "createTime" : 1.7113769114534457E9,
    "updateTime" : 1.7113769264534326E9,
    "status" : "CONVERTING",
    "ownerId" : "4c7f9e71-bfd2-49a7-a2ad-b53f11f9c9ed",
    "contentType" : "PDF",
    "title" : "job 2"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/58f6a88c-0079-4a6d-b1b3-299bb080fc2f"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/58f6a88c-0079-4a6d-b1b3-299bb080fc2f/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "58f6a88c-0079-4a6d-b1b3-299bb080fc2f",
    "createTime" : 1.7113769114534702E9,
    "updateTime" : 1.7113769264534588E9,
    "status" : "CONVERTING",
    "ownerId" : "5f6c2ead-42e6-4275-9fc3-a25b7343f5c5",
    "contentType" : "PDF",
    "title" : "job 3"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/4a5ba82d-843f-48ba-b9a9-819ccd454dc8"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/4a5ba82d-843f-48ba-b9a9-819ccd454dc8/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "4a5ba82d-843f-48ba-b9a9-819ccd454dc8",
    "createTime" : 1.7113769114534988E9,
    "updateTime" : 1.7113769264534767E9,
    "status" : "CONVERTING",
    "ownerId" : "415b6c11-63ae-4327-8294-d193a2ceb2a0",
    "contentType" : "PDF",
    "title" : "job 4"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/027b3a49-3bbe-4498-9460-e9c1f4d749c3"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/027b3a49-3bbe-4498-9460-e9c1f4d749c3/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "027b3a49-3bbe-4498-9460-e9c1f4d749c3",
    "createTime" : 1.7113769114536219E9,
    "updateTime" : 1.7113769264536076E9,
    "status" : "CONVERTING",
    "ownerId" : "bba2d523-8ff1-4021-9d08-39d190af6c0c",
    "contentType" : "PDF",
    "title" : "job 5"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/b77896c4-254f-47c2-9688-9838581342e6"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/b77896c4-254f-47c2-9688-9838581342e6/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "b77896c4-254f-47c2-9688-9838581342e6",
    "createTime" : 1.711376911453641E9,
    "updateTime" : 1.7113769264536355E9,
    "status" : "CONVERTING",
    "ownerId" : "4ad5d58c-2895-4574-8845-470f7d953e70",
    "contentType" : "PDF",
    "title" : "job 6"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/d0fa0867-0de2-4a48-97e3-3f01ebe05c53"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/d0fa0867-0de2-4a48-97e3-3f01ebe05c53/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "d0fa0867-0de2-4a48-97e3-3f01ebe05c53",
    "createTime" : 1.7113769114536786E9,
    "updateTime" : 1.711376926453653E9,
    "status" : "CONVERTING",
    "ownerId" : "9acf564f-d46b-4139-85e4-7525880a0a84",
    "contentType" : "PDF",
    "title" : "job 7"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/85907c5b-ce13-49c7-86a9-156a28b6a685"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/85907c5b-ce13-49c7-86a9-156a28b6a685/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "85907c5b-ce13-49c7-86a9-156a28b6a685",
    "createTime" : 1.7113769114537036E9,
    "updateTime" : 1.7113769264536908E9,
    "status" : "CONVERTING",
    "ownerId" : "df30e290-d22e-4014-82f9-1d08f0c1a74c",
    "contentType" : "PDF",
    "title" : "job 8"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/cb56b4cb-2317-4d20-a520-ef702904bebb"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/cb56b4cb-2317-4d20-a520-ef702904bebb/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "cb56b4cb-2317-4d20-a520-ef702904bebb",
    "createTime" : 1.711376911453721E9,
    "updateTime" : 1.7113769264537098E9,
    "status" : "CONVERTING",
    "ownerId" : "4317c08a-5c18-470b-bd32-59f63b765cf8",
    "contentType" : "PDF",
    "title" : "job 9"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/6dc50a29-5867-4a2c-8637-8f049c9f7ade"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/6dc50a29-5867-4a2c-8637-8f049c9f7ade/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "6dc50a29-5867-4a2c-8637-8f049c9f7ade",
    "createTime" : 1.7113769114537466E9,
    "updateTime" : 1.7113769264537354E9,
    "status" : "CONVERTING",
    "ownerId" : "3c98a2b8-f864-47e5-ab48-ac5d2ef3a997",
    "contentType" : "PDF",
    "title" : "job 10"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/d69665a7-8000-4cf7-842e-eef2363c20da"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/d69665a7-8000-4cf7-842e-eef2363c20da/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "d69665a7-8000-4cf7-842e-eef2363c20da",
    "createTime" : 1.7113769114537642E9,
    "updateTime" : 1.7113769264537585E9,
    "status" : "CONVERTING",
    "ownerId" : "2bbc2cc9-5f52-43da-be83-7692444929e2",
    "contentType" : "PDF",
    "title" : "job 11"
  }, {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/b016d1b9-f217-4946-8b41-d155ef310bf2"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/printers/272eb548-39e4-42b5-9e09-555a2132a59f/queues/59219603-98c0-47f7-ac85-6e02afad0804"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/69deae0b-15b2-43f3-9e1f-e65d66061fe1/jobs/b016d1b9-f217-4946-8b41-d155ef310bf2/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "b016d1b9-f217-4946-8b41-d155ef310bf2",
    "createTime" : 1.711376911453793E9,
    "updateTime" : 1.7113769264537761E9,
    "status" : "CONVERTING",
    "ownerId" : "e15c7e48-510d-4f2e-93d4-fd2687bffae7",
    "contentType" : "PDF",
    "title" : "job 12"
  } ],
  "page" : {
    "size" : 10,
    "totalElements" : 13,
    "totalPages" : 2,
    "number" : 0
  }
}

Job Example

Request:

GET /cloudprint/tenants/d0a5e60f-e0aa-45a1-a941-287c12db58ea/jobs/20ca2cdd-75e8-46fb-aac1-9c43256fcd38 HTTP/1.1
Authorization: Bearer ce43cff1-0e3a-43ce-80aa-0c7350a4d44b
Accept: application/json
Host: api.printix.net

Response:

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

{
  "tenantId" : "d0a5e60f-e0aa-45a1-a941-287c12db58ea",
  "sortOrder" : null,
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/d0a5e60f-e0aa-45a1-a941-287c12db58ea/jobs/20ca2cdd-75e8-46fb-aac1-9c43256fcd38"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/d0a5e60f-e0aa-45a1-a941-287c12db58ea/printers/08a53554-9133-41d6-9526-cc163352c8a5/queues/56a9c710-f775-4b22-ba55-3da843fc4c95"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/d0a5e60f-e0aa-45a1-a941-287c12db58ea/jobs/20ca2cdd-75e8-46fb-aac1-9c43256fcd38/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "20ca2cdd-75e8-46fb-aac1-9c43256fcd38",
    "createTime" : 1.7113769122916982E9,
    "updateTime" : 1.7113769272916825E9,
    "status" : "CONVERTED",
    "ownerId" : "e3ea679d-bcb7-48aa-bbd0-a26be6dcb852",
    "contentType" : "PDF",
    "title" : "job name"
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Delete Example

Request:

POST /cloudprint/tenants/12e232ee-44d0-4b4d-9f61-216be8a4b551/jobs/37720cb4-d2a1-489f-be6c-fd1469ddeb46/delete HTTP/1.1
Authorization: Bearer eb4b3b35-13e3-4d5d-b18d-4aa9e15246c4
Accept: application/json
Host: api.printix.net

Response:

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

{
  "success" : true,
  "message" : "The print job with id 37720cb4-d2a1-489f-be6c-fd1469ddeb46 was deleted successfully."
}

Printer List Example

Request:

GET /cloudprint/tenants/96fb9ba0-9d2b-48db-a445-63d5b0a41b29/printers?page=0&pageSize=100 HTTP/1.1
Authorization: Bearer df433cb9-5ed0-41f4-8091-aceba3de08f8
Accept: application/json
Host: api.printix.net

Response:

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

{
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/96fb9ba0-9d2b-48db-a445-63d5b0a41b29/printers?page=1&pageSize=100{&query,network,site}",
      "templated" : true
    },
    "prev" : {
      "href" : "https://api.printix.net/cloudprint/tenants/96fb9ba0-9d2b-48db-a445-63d5b0a41b29/printers?page=0&pageSize=100{&query,network,site}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "printers" : [ {
    "id" : "7fd1dffa-727d-4d0a-a7d2-bb572b3a3412",
    "name" : "Queue",
    "connectionStatus" : "ONLINE",
    "printerSignId" : "ABC",
    "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"
          }
        } ]
      }
    },
    "location" : "Office",
    "model" : "Anywhere Printer",
    "vendor" : "Printix",
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/96fb9ba0-9d2b-48db-a445-63d5b0a41b29/printers/4f99f85f-71a9-4cb7-80de-20dce5219624/queues/7fd1dffa-727d-4d0a-a7d2-bb572b3a3412"
      },
      "submit" : {
        "href" : "https://api.printix.net/cloudprint/tenants/96fb9ba0-9d2b-48db-a445-63d5b0a41b29/printers/4f99f85f-71a9-4cb7-80de-20dce5219624/queues/7fd1dffa-727d-4d0a-a7d2-bb572b3a3412/submit?title={title}&releaseImmediately=true{&user,PDL}",
        "templated" : true
      },
      "jobs" : {
        "href" : "https://api.printix.net/cloudprint/tenants/96fb9ba0-9d2b-48db-a445-63d5b0a41b29/printers/4f99f85f-71a9-4cb7-80de-20dce5219624/queues/7fd1dffa-727d-4d0a-a7d2-bb572b3a3412/jobs{?page,pageSize}",
        "templated" : true
      }
    }
  } ],
  "page" : {
    "size" : 100,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1
  }
}

Printer Info Example

Request:

GET /cloudprint/tenants/156cb5d5-13fb-441f-a06e-1064183bad9b/printers/aa04326c-f7cc-4511-afd9-84a7ae2e4ada/queues/37cf33bb-b17b-4f6f-9521-f3ebf50851c2?page=0 HTTP/1.1
Authorization: Bearer 6b5b1698-3d6f-4313-9438-9edd77ed51a4
Accept: application/json
Host: api.printix.net

Response:

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

{
  "success" : true,
  "message" : "OK",
  "printers" : [ {
    "id" : "37cf33bb-b17b-4f6f-9521-f3ebf50851c2",
    "connectionStatus" : "ONLINE",
    "printerSignId" : "ABC",
    "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"
          }
        } ]
      }
    },
    "location" : "Office",
    "model" : "Anywhere Printer",
    "vendor" : "Printix",
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/156cb5d5-13fb-441f-a06e-1064183bad9b/printers/aa04326c-f7cc-4511-afd9-84a7ae2e4ada/queues/37cf33bb-b17b-4f6f-9521-f3ebf50851c2"
      },
      "submit" : {
        "href" : "https://api.printix.net/cloudprint/tenants/156cb5d5-13fb-441f-a06e-1064183bad9b/printers/aa04326c-f7cc-4511-afd9-84a7ae2e4ada/queues/37cf33bb-b17b-4f6f-9521-f3ebf50851c2/submit?title={title}&releaseImmediately=true{&user,PDL}",
        "templated" : true
      },
      "jobs" : {
        "href" : "https://api.printix.net/cloudprint/tenants/156cb5d5-13fb-441f-a06e-1064183bad9b/printers/aa04326c-f7cc-4511-afd9-84a7ae2e4ada/queues/37cf33bb-b17b-4f6f-9521-f3ebf50851c2/jobs{?page,pageSize}",
        "templated" : true
      }
    }
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Change Owner Example

Request:

POST /cloudprint/tenants/a4462492-98b7-4c16-975a-a51c3b01857e/jobs/147af1e7-8e92-460f-b007-66a635ad281c/changeOwner HTTP/1.1
Authorization: Bearer 22fee8aa-0d52-4699-a46f-eb9a093395e8
Accept: application/json
Host: api.printix.net
Content-Type: application/x-www-form-urlencoded

userEmail=john.doe%40test.com

Response:

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

{
  "tenantId" : "a4462492-98b7-4c16-975a-a51c3b01857e",
  "sortOrder" : null,
  "success" : true,
  "message" : "OK",
  "jobs" : [ {
    "_links" : {
      "self" : {
        "href" : "https://api.printix.net/cloudprint/tenants/a4462492-98b7-4c16-975a-a51c3b01857e/jobs/147af1e7-8e92-460f-b007-66a635ad281c"
      },
      "printer" : {
        "href" : "https://api.printix.net/cloudprint/tenants/a4462492-98b7-4c16-975a-a51c3b01857e/printers/2b12edc6-0c17-412e-9cb0-e5baf17644cb/queues/0965f2aa-0216-42f0-bc9a-00838d834166"
      },
      "changeOwner" : {
        "href" : "https://api.printix.net/cloudprint/tenants/a4462492-98b7-4c16-975a-a51c3b01857e/jobs/147af1e7-8e92-460f-b007-66a635ad281c/changeOwner?userEmail={userEmail}",
        "templated" : true
      }
    },
    "id" : "147af1e7-8e92-460f-b007-66a635ad281c",
    "createTime" : 1.7113769122718325E9,
    "updateTime" : 1.71137692727183E9,
    "status" : "UPLOADING",
    "ownerId" : "48f39a50-6af1-4e59-8629-3a30ced510e8",
    "contentType" : "PDF",
    "title" : "job name"
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Create User Example

Request:

POST /cloudprint/tenants/7748e040-7f27-4385-9725-b9fb76eeac8d/users/create HTTP/1.1
Content-Type: application/json
Authorization: Bearer 7e479377-cc24-4f7d-9672-3cfd5dd7ec2c
Accept: application/json
Content-Length: 237
Host: api.printix.net

{"email":"user1@sampledomain.com","fullName":"Sample User 1","role":"GUEST_USER","pin":"9949","password":"EeGahqu7","expirationTimestamp":"2024.04.08 14:28","sendWelcomeEmail":false,"sendExpirationEmail":false,"welcomeEmailContent":null}

Response:

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

{
  "tenantId" : "7748e040-7f27-4385-9725-b9fb76eeac8d",
  "sortOrder" : null,
  "success" : true,
  "message" : "OK",
  "users" : [ {
    "id" : "4d3568c3-be02-4702-bb8b-cf3f53e3e44a",
    "fullName" : "Sample User 1",
    "email" : "user1@sampledomain.com",
    "role" : "GUEST_USER",
    "pin" : "9949",
    "idCode" : "134380",
    "password" : "EeGahqu7",
    "expirationTimestamp" : "2024.04.08 14:28",
    "sendWelcomeEmail" : false,
    "sendExpirationEmail" : false
  } ],
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

User List Example

Request:

GET /cloudprint/tenants/430757fd-7672-443a-bce7-56555fbc456d/users?page=0&pageSize=10 HTTP/1.1
Authorization: Bearer 92c239de-2ba7-48f8-b8be-d6b80169e3e8
Accept: application/json
Host: api.printix.net

Response:

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

{
  "_links" : {
    "self" : {
      "href" : "https://api.printix.net/cloudprint/tenants/430757fd-7672-443a-bce7-56555fbc456d/users?page=0&pageSize=10{&query}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.printix.net/cloudprint/tenants/430757fd-7672-443a-bce7-56555fbc456d/users?page=1&pageSize=10{&query}",
      "templated" : true
    }
  },
  "success" : true,
  "message" : "OK",
  "users" : [ {
    "id" : "5c4c8520-c460-4fe4-bf5a-14df9150f3a3",
    "fullName" : "Sample User 1",
    "email" : "user1@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.12 15:01"
  }, {
    "id" : "14aaa029-019f-416b-9f83-c14ba13b9c76",
    "fullName" : "Sample User 2",
    "email" : "user2@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.14 15:07"
  }, {
    "id" : "9abf3640-2eeb-432c-8393-bff163139cbd",
    "fullName" : "Sample User 3",
    "email" : "user3@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.03.29 14:31"
  }, {
    "id" : "145ee431-74ef-4ca9-8cdc-4f93e264aebe",
    "fullName" : "Sample User 4",
    "email" : "user4@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.09 14:55"
  }, {
    "id" : "b6d2dfa3-fb49-487a-83a8-ce5bcd0f74bb",
    "fullName" : "Sample User 5",
    "email" : "user5@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.02 14:53"
  }, {
    "id" : "70b23558-0f74-45f6-86d4-2c0fd6b5eef2",
    "fullName" : "Sample User 6",
    "email" : "user6@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.12 14:45"
  }, {
    "id" : "f41e3d2d-1c7e-468c-ad8b-0eacc7cbf391",
    "fullName" : "Sample User 7",
    "email" : "user7@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.18 15:12"
  }, {
    "id" : "80f87c7d-4c7a-4983-8d14-e68d57e850b1",
    "fullName" : "Sample User 8",
    "email" : "user8@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.03.29 14:46"
  }, {
    "id" : "fb211f89-613d-477e-b7b5-49f40680e33a",
    "fullName" : "Sample User 9",
    "email" : "user9@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.03.31 15:14"
  }, {
    "id" : "f9d91a85-1710-45fe-ac6e-50f90f4f3a67",
    "fullName" : "Sample User 10",
    "email" : "user10@sampledomain.com",
    "role" : "GUEST_USER",
    "expirationTimestamp" : "2024.04.07 15:25"
  } ],
  "page" : {
    "size" : 10,
    "totalElements" : 10,
    "totalPages" : 1,
    "number" : 0
  }
}

Delete User Example

Request:

POST /cloudprint/tenants/15582ec2-70c7-4365-997d-3c35aaeaff71/users/c5fae8af-006b-40fe-9fc9-9a8e7fb1a176/delete HTTP/1.1
Authorization: Bearer cf7b1b3b-5d22-48c9-8cba-aee183dad7a9
Accept: application/json
Host: api.printix.net

Response:

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

{
  "success" : true,
  "message" : "The user with id c5fae8af-006b-40fe-9fc9-9a8e7fb1a176 was deleted successfully."
}