Render a planar nesting as an image per sheet
Renders a previously computed planar nesting to a PNG image per sheet,
each returned as a base64-encoded string. Get a NestId by calling
PlanarPartsNesting2D — the returned
NestingId is what to pass here.
x-api-keyField | Type | Required | Description |
|---|---|---|---|
| NestId | uuid | Yes | Path parameter. The |
| SheetId | uuid | Yes | Path parameter. Reserved for future per-sheet filtering. Currently ignored — every sheet in the nest is returned regardless of the value supplied. Retained in the URL for forward compatibility. |
application/jsonField | Type | Required | Description |
|---|---|---|---|
| imageWidth | integer | No | Image width in pixels. Must be greater than zero. Defaults to
|
| imageHeight | integer | No | Image height in pixels. Must be greater than zero. Defaults to
|
| backgroundColor | string | No | Canvas background color as an HTML hex string (e.g. |
| shouldKeepRemnant | boolean | No | When |
| shouldRenderFullSheet | boolean | No | Only meaningful when ShouldKeepRemnant is |
| crop | object | No | Styling for the remnant crop overlay (the cut-line polygon and its
fill). Only applied when ShouldKeepRemnant is
|
| crop. | string | No | Fill color as an HTML hex string. Supports optional alpha:
|
| crop. | enum | null | No | Hatch pattern applied on top of FillColor. Values are those
of HatchStyle (e.g. Show 53 values"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond" |
| crop. | string | No | Stroke color as an HTML hex string. Default: |
| crop. | enum | No | Stroke dash pattern. One of "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| deadZone | object | No | Styling for the no-nesting buffer zone at the sheet origin (the inset rectangle from the bottom-left where parts are not allowed to be placed). Only rendered when the nest has a non-zero dead-zone offset. |
| deadZone. | string | No | Fill color as an HTML hex string. Supports optional alpha:
|
| deadZone. | enum | null | No | Hatch pattern applied on top of FillColor. Values are those
of HatchStyle (e.g. Show 53 values"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond" |
| deadZone. | string | No | Stroke color as an HTML hex string. Default: |
| deadZone. | enum | No | Stroke dash pattern. One of "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| part | object | No | Styling for placed (used) parts on the sheet. |
| part. | string | No | Fill color as an HTML hex string. Supports optional alpha:
|
| part. | enum | null | No | Hatch pattern applied on top of FillColor. Values are those
of HatchStyle (e.g. Show 53 values"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond" |
| part. | string | No | Stroke color as an HTML hex string. Default: |
| part. | enum | No | Stroke dash pattern. One of "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| remnant | object | No | Styling for unused / leftover positions on the sheet. |
| remnant. | string | No | Fill color as an HTML hex string. Supports optional alpha:
|
| remnant. | enum | null | No | Hatch pattern applied on top of FillColor. Values are those
of HatchStyle (e.g. Show 53 values"Horizontal""Vertical""ForwardDiagonal""BackwardDiagonal""Cross""DiagonalCross""Percent05""Percent10""Percent20""Percent25""Percent30""Percent40""Percent50""Percent60""Percent70""Percent75""Percent80""Percent90""LightDownwardDiagonal""LightUpwardDiagonal""DarkDownwardDiagonal""DarkUpwardDiagonal""WideDownwardDiagonal""WideUpwardDiagonal""LightVertical""LightHorizontal""NarrowVertical""NarrowHorizontal""DarkVertical""DarkHorizontal""DashedDownwardDiagonal""DashedUpwardDiagonal""DashedHorizontal""DashedVertical""SmallConfetti""LargeConfetti""ZigZag""Wave""DiagonalBrick""HorizontalBrick""Weave""Plaid""Divot""DottedGrid""DottedDiamond""Shingle""Trellis""Sphere""SmallGrid""SmallCheckerBoard""LargeCheckerBoard""OutlinedDiamond""SolidDiamond" |
| remnant. | string | No | Stroke color as an HTML hex string. Default: |
| remnant. | enum | No | Stroke dash pattern. One of "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
Status | When |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data | object | null | No | Response payload for the render-planar-nest endpoint. Returned inside a
|
| data. | uuid | No | Echo of the |
| data. | object[] | No | One rendered image per sheet in the nest. |
| data. | uuid | No | Identifier of the sheet this image belongs to. Matches a
|
| data. | string | No | Rendered sheet image, base64-encoded PNG. Decode to bytes to obtain
the raw image. The |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on. |
| errors[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"data": {
"nestId": "99d4d3b5-18a3-4e18-b6c3-a40bd48c02fa",
"images": [
{
"sheetId": "1c65aa74-73fc-4fac-b8af-41acabfc39cc",
"imageData": "string"
}
]
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}