Classify an imported 2D part as a planar (sheet-metal) blank
Classifies an imported 2D part as a planar sheet-metal blank and returns
its measured dimensions (flat-pattern length, width, cut path, hole
counts, and volume). Get a PartId by uploading a file
here — every imported file yields one or more parts.
To classify a 3D sheet-metal file (STEP), import it through
ImportFiles3D with Unfold=true and pass that part id here.
x-api-keyField | Type | Required | Description |
|---|---|---|---|
| PartId | uuid | Yes | Identifier of the imported part to classify. |
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 2D planar parts-classification endpoint. Returned inside a
|
| data. | object | No | Classification result for the requested part. |
| data. | uuid | No | Echo of the |
| data. | string | No | Broad part family. For planar parts this is always the literal
|
| data. | string | No | Measurement unit of every dimension returned in Dimensions.
Sourced from the CAD file the part was imported from. Common values:
|
| data. | object | No | Measured dimensions of the classified flat blank. |
| data. | number | No | Flat blank outline area with hole and cutout areas subtracted — the actual material area of the sheet. |
| data. | number | No | Flat blank outline area with hole and cutout areas filled in (outer contour area only). Equals SurfaceArea when the part has no holes. |
| data. | integer | No | Total count of closed contour loops in the flat pattern — the outer profile plus any inner boundaries (holes, cutouts). |
| data. | number | No | Sum of the perimeters of every inner contour (all hole and cutout perimeters). Zero when the part has no interior features. |
| data. | number | No | Bounding-box X extent of the flat outline. |
| data. | number | No | Total cut-path length — sum of the perimeters of every contour, outer plus every inner. Represents the full laser/plasma cut distance. |
| data. | number | No | Area of the axis-aligned bounding rectangle around the flat outline —
|
| data. | number | No | Detected sheet-metal gauge. |
| data. | number | No | Bounding-box Y extent of the flat outline. |
| data. | number | No | Combined side-wall area of all interior features (hole and cutout
perimeters extruded through the sheet thickness). Approximately
|
| data. | number | No | Material volume of the flat blank — |
| data. | integer | No | Number of detected bend lines. |
| 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": {
"part": {
"partId": "08fcc2e5-7760-493b-b8f1-1ad26fcb0a9e",
"partType": "string",
"measurementUnit": "string",
"dimensions": {
"surfaceArea": 0.1,
"fullSurfaceArea": 0.1,
"contours": 0,
"internalLength": 0.1,
"length": 0.1,
"cutLength": 0.1,
"rectangularArea": 0.1,
"thickness": 0.1,
"width": 0.1,
"internalSurfaceArea": 0.1,
"volume": 0.1
},
"bendCount": 0
}
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}