Render a planar nest to images
This endpoint renders a previously created planar nest to one or more images.
You can specify the dimensions of the image, as well as the colors and styles used to represent different elements of the nest (e.g., parts, remnants, dead zones, crop areas).
Note: Rendering a nest does not modify the nest itself; it simply generates visual representations based on the current state of the nest.
x-api-keyField | Type | Required |
|---|---|---|
| NestId | uuid | Yes |
| SheetId | uuid | Yes |
application/jsonField | Type | Required | Description |
|---|---|---|---|
| shouldKeepRemnant | boolean | No | |
| shouldRenderFullSheet | boolean | No | |
| backgroundColor | string | No | |
| imageHeight | integer | No | |
| imageWidth | integer | No | |
| imageType | string | No | |
| crop | object | No | |
| crop. | string | No | |
| crop. | enum | null | No | 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 | |
| crop. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| deadZone | object | No | |
| deadZone. | string | No | |
| deadZone. | enum | null | No | 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 | |
| deadZone. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| part | object | No | |
| part. | string | No | |
| part. | enum | null | No | 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 | |
| part. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
| remnant | object | No | |
| remnant. | string | No | |
| remnant. | enum | null | No | 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 | |
| remnant. | enum | No | "Solid""Dash""Dot""DashDot""DashDotDot""Custom" |
Status | When |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Server Error |
Field | Type | Required | Description |
|---|---|---|---|
| nestingId | uuid | No | The unique identifier for the nesting operation. |
| sheet | object | No | The collection of Sheet information used in the nesting operation. |
| sheet. | uuid | No | Unique identifier for the sheet/plate |
| sheet. | string | No | Display name of the sheet material |
| sheet. | string | No | Product identifier for the sheet in the material catalog |
| sheet. | number | No | Material density |
| sheet. | string | No | Unit of measure for density |
| sheet. | number | No | Sheet thickness |
| sheet. | string | No | Unit of measure for thickness |
| sheet. | string | No | Material classification (e.g., "Steel", "Aluminum") |
| sheet. | number | No | Sheet length |
| sheet. | string | No | Unit of measure for length |
| sheet. | number | No | Sheet width |
| sheet. | string | No | Unit of measure for width |
| sheet. | string | No | Unit of measure for weight values |
| sheet. | number | No | Total weight of all plates. |
| sheet. | number | No | Total used weight of all plates. |
| sheet. | integer | No | Total number of sheets required to nest parts. |
| sheet. | number | No | Average utilization percentage across all sheets |
| sheet. | object[] | No | Breakdown of how sheets are used across the nesting groups |
| sheet. | boolean | No | Whether remnant material is retained after this nesting group |
| sheet. | string | No | How the remnant is cropped (e.g., "full-width", "partial") |
| sheet. | number | No | Total material weight consumed in this nesting group |
| sheet. | integer | No | Number of sheets in this nesting group |
| sheet. | object[] | No | Parts nested on the sheets in this nesting group |
| sheet. | uuid | No | Unique identifier for the part |
| sheet. | integer | No | Total number of parts nested on all sheets in group. |
| sheet. | number | No | Weight of one nested piece of this part |
{
"nestingId": "11e99bc8-e511-474a-b049-938734f567db",
"sheet": {
"sheetId": "1c65aa74-73fc-4fac-b8af-41acabfc39cc",
"name": "string",
"productId": "string",
"density": 0.1,
"densityUnit": "string",
"thickness": 0.1,
"thicknessUnit": "string",
"materialType": "string",
"length": 0.1,
"lengthUnit": "string",
"width": 0.1,
"widthUnit": "string",
"weightUnit": "string",
"totalWeight": 0.1,
"totalWeightUsed": 0.1,
"numberOfSheetsRequired": 0,
"numberOfSheetsPercentage": 0.1,
"sheetUsage": [
{
"keepRemnant": true,
"remnantCropType": "string",
"weightUsed": 0.1,
"numberOfSheets": 0,
"partsUsed": [
{
"partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
"numberOfPartsNested": 0,
"unitNestedWeight": 0.1
}
]
}
]
}
}