Create a single-part linear nest
Nests a single part onto linear stock. Returns per-bar cut-list and yield results. To nest multiple distinct part types in one call, use LinearNestMultipleParts.
x-api-keyapplication/jsonField | Type | Required |
|---|---|---|
| outputLengthUnit | string | No |
| outputWeightUnit | string | No |
| stock | object | Yes |
| stock. | string | No |
| stock. | number | Yes |
| stock. | string | No |
| stock. | number | Yes |
| stock. | string | No |
| stock. | integer | null | No |
| options | object | null | 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 | No |
| part | object | Yes |
| part. | number | Yes |
| part. | string | Yes |
| part. | integer | Yes |
Status | When |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data | object | null | No | |
| data. | uuid | No | Unique identifier for the nesting result |
| data. | object | No | Nesting result for the single part |
| data. | uuid | No | Unique identifier for the part |
| data. | integer | No | Requested quantity for this part |
| data. | number | No | Required cut length per piece |
| data. | string | No | Unit of measure for the length (e.g., "Inch", "Millimeter") |
| data. | integer | No | Total number of pieces successfully nested |
| data. | number | No | Total cut length for all nested pieces |
| data. | number | No | Total weight of the nested material used |
| data. | number | No | Total true (actual part geometry) weight of all nested pieces |
| data. | object[] | No | Collection of stock layouts used to fulfill the part quantity |
| data. | uuid | No | Unique identifier for the stock item |
| data. | integer | No | Number of parts cut from a single stock unit |
| data. | boolean | No | Whether remnants are retained after cutting |
| data. | integer | No | Total number of stock units required |
| data. | number | No | Total length of all stock units combined |
| data. | number | No | Total length consumed across all stock units |
| data. | number | No | Total weight of all stock units combined |
| data. | number | No | Total weight of material consumed across all stock units |
| data. | number | No | Length of a single stock unit |
| data. | number | No | Length consumed from a single stock unit |
| data. | number | No | Weight of a single stock unit |
| data. | number | No | Weight of material consumed from a single stock unit |
| data. | string | No | Unit of measure for all length values |
| data. | string | No | Unit of measure for all weight values |
| data. | object | No | The part nested on this stock layout |
| data. | uuid | No | Unique identifier for the part |
| data. | integer | No | Number of pieces of this part cut from the stock unit |
| 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": {
"nestingId": "11e99bc8-e511-474a-b049-938734f567db",
"part": {
"partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
"quantity": 0,
"length": 0.1,
"lengthUnit": "string",
"totalItemsNested": 0,
"totalNestedLength": 0.1,
"totalNestedWeight": 0.1,
"totalTrueWeight": 0.1
},
"stock": [
{
"stockId": "a43dc3b0-820c-4762-b37b-45e91f17720c",
"numberOfPartsPerUnit": 0,
"keepRemnant": true,
"numberOfUnits": 0,
"totalStockLength": 0.1,
"totalStockLengthUsed": 0.1,
"totalStockWeight": 0.1,
"totalStockWeightUsed": 0.1,
"unitStockLength": 0.1,
"unitStockLengthUsed": 0.1,
"unitStockWeight": 0.1,
"unitStockWeightUsed": 0.1,
"lengthUnit": "string",
"weightUnit": "string",
"part": {
"partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
"quantity": 0
}
}
]
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}