PrintQueueApi
| Method | HTTP request | Description |
|---|---|---|
| cancel_all_active_print_jobs | POST /api/web/v1/prints/{printerId}/cancelAllActivePrints | Cancel all active jobs for a given printer. |
| delete_print_job | DELETE /api/web/v1/prints/{printJobId} | Delete the given print job. |
| get_paginated_print_jobs | POST /api/web/v1/prints/paginated | View print jobs in paginated form. |
| get_print_job | GET /api/web/v1/prints/{printJobId} | Get the given print job. |
| get_print_jobs | GET /api/web/v1/prints | List all print jobs. |
cancel_all_active_print_jobs
cancel_all_active_print_jobs(printer_id)
Cancel all active jobs for a given printer.
This API cancels the ongoing job on printer. This should be used if any job is stuck on printer i.e. the printer is not processing the job anymore and is stuck in busy state for more than 5 minutes.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printer_id | str | Printer Id. This can be obtained from the id value in the response of Return a Specified Printer API call. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
delete_print_job
delete_print_job(print_job_id)
Delete the given print job.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| print_job_id | str | Print ID |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
get_paginated_print_jobs
PrintQueuePaging get_paginated_print_jobs(search_parms)
View print jobs in paginated form.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Authorization information is missing or invalid | - |
| 500 | Unexpected error | - |
get_print_job
PrintJob get_print_job(print_job_id)
Get the given print job.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| print_job_id | str | Print ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
get_print_jobs
List[PrintJob] get_print_jobs()
List all print jobs.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Authorization information is missing or invalid | - |
| 500 | Unexpected error | - |