Create a single-part nest
This endpoint creates a planar nest for a single part on a specified sheet. Need to turn a file into parts? Check out Import Parts
Note: If you need to nest multiple parts, please use the multi-part nesting endpoint.
x-api-keyapplication/jsonField | Type | Required | Description |
|---|---|---|---|
| outputLengthUnit | string | No | The unit of measurement for output lengths. |
| outputWeightUnit | string | No | The unit of measurement for output weights. |
| options | object | Yes | |
| options. | object | No | |
| options. | number | No | |
| options. | string | No | |
| options. | number | No | |
| options. | string | No | |
| options. | object | No | |
| options. | number | No | |
| options. | string | No | |
| options. | number | No | |
| options. | string | No | |
| options. | object | No | |
| options. | number | No | |
| options. | string | No | |
| options. | number | No | |
| options. | string | No | |
| options. | object | No | |
| options. | boolean | No | |
| options. | number | null | No | |
| options. | string | null | No | |
| options. | number | null | No | |
| options. | string | null | No | |
| sheet | object | Yes | |
| sheet. | string | No | |
| sheet. | string | No | |
| sheet. | string | null | No | |
| sheet. | string | No | |
| sheet. | number | No | |
| sheet. | string | No | |
| sheet. | number | No | |
| sheet. | string | No | |
| sheet. | number | No | |
| sheet. | string | No | |
| sheet. | number | No | |
| sheet. | string | No | |
| sheet. | integer | No | |
| part | object | Yes | |
| part. | uuid | Yes | |
| part. | string | No | |
| part. | string | null | No | Override for the part's measurement unit. Leave null to use the unit stored on the part. |
| part. | boolean | No | |
| part. | integer | No |
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 |
| part | object | No | The part response included in the nesting operation. |
| part. | uuid | No | The unique identifier for the part. |
| part. | string | No | The given name of the part. |
| part. | number | No | The unit rectangular weight of the part. |
| part. | number | No | The true weight of the 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
}
]
}
]
},
"part": {
"partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
"name": "string",
"unitRectangularWeight": 0.1,
"unitTrueWeight": 0.1
}
}