Skip to content
Stella ConnectDocs
Nesting

Render a planar nest to images

POST{baseUrl}/v1.0/nesting/planar/{NestId}/sheets/{SheetId}/rendering

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.

Authx-api-key

Field
Type
Required
NestIduuidYes
SheetIduuidYes

application/json
Field
Type
Required
Description
shouldKeepRemnantbooleanNo
shouldRenderFullSheetbooleanNo
backgroundColorstringNo
imageHeightintegerNo
imageWidthintegerNo
imageTypestringNo
cropobjectNo
crop.fillColorstringNo
crop.hatchStyleenum | nullNo
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.strokeColorstringNo
crop.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
deadZoneobjectNo
deadZone.fillColorstringNo
deadZone.hatchStyleenum | nullNo
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.strokeColorstringNo
deadZone.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
partobjectNo
part.fillColorstringNo
part.hatchStyleenum | nullNo
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.strokeColorstringNo
part.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"
remnantobjectNo
remnant.fillColorstringNo
remnant.hatchStyleenum | nullNo
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.strokeColorstringNo
remnant.strokeStyleenumNo
"Solid""Dash""Dot""DashDot""DashDotDot""Custom"

Status
When
200

Success

400

Bad Request

401

Unauthorized

500

Server Error

Field
Type
Required
Description
nestingIduuidNo

The unique identifier for the nesting operation.

sheetobjectNo

The collection of Sheet information used in the nesting operation.

sheet.sheetIduuidNo

Unique identifier for the sheet/plate

sheet.namestringNo

Display name of the sheet material

sheet.productIdstringNo

Product identifier for the sheet in the material catalog

sheet.densitynumberNo

Material density

sheet.densityUnitstringNo

Unit of measure for density

sheet.thicknessnumberNo

Sheet thickness

sheet.thicknessUnitstringNo

Unit of measure for thickness

sheet.materialTypestringNo

Material classification (e.g., "Steel", "Aluminum")

sheet.lengthnumberNo

Sheet length

sheet.lengthUnitstringNo

Unit of measure for length

sheet.widthnumberNo

Sheet width

sheet.widthUnitstringNo

Unit of measure for width

sheet.weightUnitstringNo

Unit of measure for weight values

sheet.totalWeightnumberNo

Total weight of all plates.

sheet.totalWeightUsednumberNo

Total used weight of all plates.

sheet.numberOfSheetsRequiredintegerNo

Total number of sheets required to nest parts.

sheet.numberOfSheetsPercentagenumberNo

Average utilization percentage across all sheets

sheet.sheetUsage[]object[]No

Breakdown of how sheets are used across the nesting groups

sheet.sheetUsage[].keepRemnantbooleanNo

Whether remnant material is retained after this nesting group

sheet.sheetUsage[].remnantCropTypestringNo

How the remnant is cropped (e.g., "full-width", "partial")

sheet.sheetUsage[].weightUsednumberNo

Total material weight consumed in this nesting group

sheet.sheetUsage[].numberOfSheetsintegerNo

Number of sheets in this nesting group

sheet.sheetUsage[].partsUsed[]object[]No

Parts nested on the sheets in this nesting group

sheet.sheetUsage[].partsUsed[].partIduuidNo

Unique identifier for the part

sheet.sheetUsage[].partsUsed[].numberOfPartsNestedintegerNo

Total number of parts nested on all sheets in group.

sheet.sheetUsage[].partsUsed[].unitNestedWeightnumberNo

Weight of one nested piece of this part

Example 200 response
{
  "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
          }
        ]
      }
    ]
  }
}