Skip to content
Stella ConnectDocs
Parts

Classify an imported 2D part as a planar (sheet-metal) blank

GET{baseUrl}/v2.0/2d/parts/{PartId}/classification/planar

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.

Authx-api-key

Field
Type
Required
Description
PartIduuidYes

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
dataobject | nullNo

Response payload for the 2D planar parts-classification endpoint. Returned inside a ConnectEnvelope<PlanarPartsClassification2DResponse>.

data.partobjectNo

Classification result for the requested part.

data.part.partIduuidNo

Echo of the PartId that was classified.

data.part.partTypestringNo

Broad part family. For planar parts this is always the literal "Planar". (For linear parts the equivalent field echoes the linear family name — see the linear classification endpoint.)

data.part.measurementUnitstringNo

Measurement unit of every dimension returned in Dimensions. Sourced from the CAD file the part was imported from. Common values: "inch", "millimeter", "meter". Defaults to "inch" when the file does not specify one.

data.part.dimensionsobjectNo

Measured dimensions of the classified flat blank.

data.part.dimensions.surfaceAreanumberNo

Flat blank outline area with hole and cutout areas subtracted — the actual material area of the sheet.

data.part.dimensions.fullSurfaceAreanumberNo

Flat blank outline area with hole and cutout areas filled in (outer contour area only). Equals SurfaceArea when the part has no holes.

data.part.dimensions.contoursintegerNo

Total count of closed contour loops in the flat pattern — the outer profile plus any inner boundaries (holes, cutouts).

data.part.dimensions.internalLengthnumberNo

Sum of the perimeters of every inner contour (all hole and cutout perimeters). Zero when the part has no interior features.

data.part.dimensions.lengthnumberNo

Bounding-box X extent of the flat outline.

data.part.dimensions.cutLengthnumberNo

Total cut-path length — sum of the perimeters of every contour, outer plus every inner. Represents the full laser/plasma cut distance.

data.part.dimensions.rectangularAreanumberNo

Area of the axis-aligned bounding rectangle around the flat outline — Length × Width. Useful as a rough stock-sizing proxy.

data.part.dimensions.thicknessnumberNo

Detected sheet-metal gauge. 0 when the classifier could not determine a thickness (e.g. pure 2D input with no third dimension).

data.part.dimensions.widthnumberNo

Bounding-box Y extent of the flat outline.

data.part.dimensions.internalSurfaceAreanumberNo

Combined side-wall area of all interior features (hole and cutout perimeters extruded through the sheet thickness). Approximately InternalLength × Thickness. Zero when there are no interior features or when Thickness is 0.

data.part.dimensions.volumenumberNo

Material volume of the flat blank — SurfaceArea × Thickness.

data.part.bendCountintegerNo

Number of detected bend lines. 0 for a flat blank; greater than 0 for a bent sheet-metal part (the value here reflects the count of bends in the source 3D geometry).

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

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[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

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