PrintQueueApi
| Method | HTTP request | Description |
|---|---|---|
| cancelAllActivePrintJobs | POST /api/web/v1/prints/{printerId}/cancelAllActivePrints | Cancel all active jobs for a given printer. |
| deletePrintJob | DELETE /api/web/v1/prints/{printJobId} | Delete the given print job. |
| getPaginatedPrintJobs | POST /api/web/v1/prints/paginated | View print jobs in paginated form. |
| getPrintJob | GET /api/web/v1/prints/{printJobId} | Get the given print job. |
| getPrintJobs | GET /api/web/v1/prints | List all print jobs. |
cancelAllActivePrintJobs
cancelAllActivePrintJobs(printerId)
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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printerId | String | Printer Id. This can be obtained from the id value in the response of Return a Specified Printer API call. |
Return type
null (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 | - |
deletePrintJob
deletePrintJob(printJobId)
Delete the given print job.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printJobId | String | Print ID |
Return type
null (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 | - |
getPaginatedPrintJobs
PrintQueuePaging getPaginatedPrintJobs(searchParms)
View print jobs in paginated form.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | 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 | - |
getPrintJob
PrintJob getPrintJob(printJobId)
Get the given print job.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printJobId | String | 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 | - |
getPrintJobs
List<PrintJob> getPrintJobs()
List all print jobs.
Example
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 | - |