API Endpoint Reference / Print Jobs
Approve the reported holds of a creation request and re-slice
POST https://api.printhiv3d.com/v1/print-jobs/create-requests/{requestId}/approve-review
Operation ID approvePrintJobCreateRequestReview. Requires the control API key scope.
Requires control scope. Read the request first: each hold in `requiredActions` lists its `allowedActions`, and approval succeeds only when every hold of the request lists `approve`. A request held for an engine setting review (`project_review_required` with `changes`) takes `{ changes, sourceRelease, engineRelease }` copied from the hold. A request held for `inspection_review_required` with reason `material_usage_unresolved` takes `{ inspection: { plateVersion } }` with the `plateVersion` that the hold reported. A request held for both takes both. Other inspection reasons, and every other hold code on any held plate, allow cancel only. A request with a `printer_id` has one plate. A request without one has a plate for each target configuration, and `plateVersion` covers every held plate: one approval applies to all of them. Approval of a changed plate returns 409: read the request again for its current holds and `plateVersion`.
Parameters
| Name | In | Type | Required | Description |
|---|
requestId | path | string | Yes | |
Request body
Content type application/json.
Send one of these shapes.
Option 1
| Field | Type | Required | Description |
|---|
changes | object[] | Yes | |
sourceRelease | string | null | Yes | |
engineRelease | string | Yes | |
Option 2
| Field | Type | Required | Description |
|---|
inspection | object | Yes | |
Option 3
| Field | Type | Required | Description |
|---|
changes | object[] | Yes | |
sourceRelease | string | null | Yes | |
engineRelease | string | Yes | |
inspection | object | Yes | |
Responses
| Status | Description |
|---|
202 | Default Response |
400 | Invalid request or organization scope |
401 | Authentication required |
403 | Insufficient API key scope or organization membership, or an inspection approval from a principal that is neither an API key nor a signed-in user, so Hive has no actor to record (approval_actor_required) |
404 | Creation request not found |
409 | The approval does not match the held creation request: the plate changed, a hold does not allow approval, or the body names a review the plate does not hold (review_conflict) |
500 | Unexpected server error |
503 | Creation request storage unavailable |
202 response fields
| Field | Type | Required | Description |
|---|
approved | boolean | Yes | |
400 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
statusCode | integer | No | |
401 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
statusCode | integer | No | |
403 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
statusCode | integer | No | |
404 response fields
| Field | Type | Required | Description |
|---|
error | string | Yes | |
message | string | No | |
requestId | string | No | |
409 response fields
| Field | Type | Required | Description |
|---|
error | string | Yes | |
message | string | No | |
requestId | string | No | |
500 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
statusCode | integer | No | |
503 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
statusCode | integer | No | |
Example 202 response
{
"approved": true
}