Render a linear nesting as an image
Renders a previously computed linear nesting to a PNG or SVG image,
returned as a base64-encoded string. Get a NestId by calling
LinearPartsNesting3D or
LinearPartsPartLookupNesting3D —
the returned NestingId is what to pass here.
x-api-keyField | Type | Required | Description |
|---|---|---|---|
| NestId | uuid | Yes | Identifier of the nesting to render — the |
application/jsonField | Type | Required | Description |
|---|---|---|---|
| imageType | enum | No | Output image format. Default: "Png""Svg" |
| imageWidth | integer | null | No | Width of the rendered image in pixels. Must be greater than 0. Default: |
| imageHeight | integer | null | No | Height of the rendered image in pixels. Must be greater than 0. Default: |
| chuck | object | No | Styling for the chuck region drawn at the start of every stock bar. |
| chuck. | string | No | Fill color as an HTML hex string. Supports optional alpha:
|
| chuck. | 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" |
| chuck. | string | No | Stroke color as an HTML hex string. Default: |
| chuck. | enum | No | Stroke dash pattern. One of "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| kerf | object | No | Styling for the kerf (saw-blade waste) drawn between adjacent parts. |
| kerf. | string | No | Fill color as an HTML hex string. Supports optional alpha:
|
| kerf. | 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" |
| kerf. | string | No | Stroke color as an HTML hex string. Default: |
| kerf. | enum | No | Stroke dash pattern. One of "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| part | object | No | Styling for the part bodies laid on each stock bar. |
| 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 the remnant region left after the final cut on each stock bar. |
| 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 |
| 404 | Not Found |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data | object | null | No | Response payload for the render-linear-nest endpoint. Returned inside a
|
| data. | uuid | No | Echo of the |
| data. | string | No | Rendered image, base64-encoded. Decode to bytes and interpret according to
the requested |
| 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",
"imageData": "string"
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}