API Endpoint Reference / Print Jobs

Cancel an unclaimed queued print without a printer command

POST https://api.printhiv3d.com/v1/print-jobs/{id}/cancel-queued

Operation ID cancelQueuedPrintJob. Requires the control API key scope.

Parameters

NameInTypeRequiredDescription
idpathintegerYes

Responses

StatusDescription
200Default Response
403Default Response
404Default Response
409Default Response
503Default Response

200 response fields

FieldTypeRequiredDescription
jobIdintegerYes
status"CANCELLED"Yes

403 response fields

FieldTypeRequiredDescription
errorstringYes
codestringNo
messagestringNo
requestIdstringNo

404 response fields

FieldTypeRequiredDescription
error"print_job_not_found" | "print_job_terminal" | "queued_cancel_conflict" | "queued_cancel_unavailable" | "stop_attempt_conflict" | "stop_identity_conflict" | "stop_job_terminal" | "stop_not_delivered" | "stop_not_ready" | "stop_receipt_not_found" | "stop_transport_unknown" | "stop_unavailable" | "stop_unsupported"Yes
reasonstringYes
messagestringYes
jobStatusstring | nullNo
printerFamilystring | nullNo

409 response fields

FieldTypeRequiredDescription
error"print_job_not_found" | "print_job_terminal" | "queued_cancel_conflict" | "queued_cancel_unavailable" | "stop_attempt_conflict" | "stop_identity_conflict" | "stop_job_terminal" | "stop_not_delivered" | "stop_not_ready" | "stop_receipt_not_found" | "stop_transport_unknown" | "stop_unavailable" | "stop_unsupported"Yes
reasonstringYes
messagestringYes
jobStatusstring | nullNo
printerFamilystring | nullNo

503 response fields

FieldTypeRequiredDescription
error"print_job_not_found" | "print_job_terminal" | "queued_cancel_conflict" | "queued_cancel_unavailable" | "stop_attempt_conflict" | "stop_identity_conflict" | "stop_job_terminal" | "stop_not_delivered" | "stop_not_ready" | "stop_receipt_not_found" | "stop_transport_unknown" | "stop_unavailable" | "stop_unsupported"Yes
reasonstringYes
messagestringYes
jobStatusstring | nullNo
printerFamilystring | nullNo

Example 200 response

{
  "jobId": 48213,
  "status": "CANCELLED"
}