Skip to content
Stella ConnectDocs
Parts

Classify an imported 3D part as linear stock

GET{baseUrl}/v2.0/3d/parts/{PartId}/classification/linear

Classifies an imported 3D part as a linear stock item — a bar, tube, structural shape, or pipe — and returns its family, sub-type, and measured dimensions (length, cross-section, surface areas, volume). Get a PartId by uploading a file here — every imported file yields one or more parts.

Authx-api-key

Field
Type
Required
PartIduuidYes

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 linear parts-classification endpoints. Returned inside a ConnectEnvelope<LinearPartsClassificationResponse>.

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 linear parts this currently echoes LinearPartType — one of "Bar", "Tube", "Structural", "Pipe", or "Unknown". Consumers integrating against both linear and planar endpoints should note that the planar endpoints return the literal "Planar" here instead.

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.linearPartTypestringNo

Linear family classification. One of: "Bar" (solid stock), "Tube" (hollow closed-profile stock), "Structural" (rolled structural shapes — I-beam, channel, angle), "Pipe" (currently not returned — reserved), or "Unknown" when the classifier cannot identify a linear family.

data.part.linearPartSubTypestringNo

Specific cross-section within LinearPartType. Values: "Bar_Flat", "Bar_Square", "Bar_Round", "Bar_Hex" "Tube_Round", "Tube_Square", "Tube_Rectangular" "Structural_IBeam", "Structural_Channel", "Structural_Angle" "Pipe_Seamless", "Pipe_Welded" — reserved; not currently returned

data.part.dimensionsobject | nullNo

Measured dimensions of the classified part. Null when the classifier could not extract dimensions (e.g. LinearPartSubType is unknown).

data.part.dimensions.crossSectionalDimensionsobject | nullNo

Dimensions of the part's cross-section (the profile perpendicular to its long axis). Null when a cross-section could not be extracted.

data.part.dimensions.contoursintegerNo

Number of closed contours in the part's cross-section — the outer profile plus any inner boundaries (e.g. a round tube has 2: outer circle + bore).

data.part.dimensions.internalLengthnumberNo

Sum of the perimeter lengths of every inner contour on the cross-section (e.g. the bore perimeter of a tube, plus any through-holes). Zero for solid parts with no inner contours.

data.part.dimensions.lengthnumberNo

Overall length along the part's primary axis, measured from the tightest axis-aligned bounding box (fillet corners excluded).

data.part.dimensions.profileLengthnumberNo

Perimeter of the cross-section's outer contour (the "profile" length).

data.part.dimensions.surfaceAreanumberNo

Total outer skin area of the part, including both end caps but excluding interior hole/bore walls.

data.part.dimensions.outsideSurfaceAreanumber | nullNo

Area of the outer wall along the part's length (excludes end caps). Populated only for tubes and pipes; null for bars and structural shapes.

data.part.dimensions.insideSurfaceAreanumber | nullNo

Area of the inner bore wall along the part's length (excludes end caps). Populated only for tubes and pipes; null for bars and structural shapes.

data.part.dimensions.internalSurfaceAreanumberNo

Sum of the wall areas of all interior features other than a tube's bore — through-holes, counterbores, chamfers, notches. Zero for parts with no such features. Note: for tubes the bore wall itself is reported in InsideSurfaceArea, not here.

data.part.dimensions.crossSectionalSurfaceAreanumberNo

Combined area of the two end-cap faces (both cut ends). For tubes this is twice the annular ring area; for solid bars it is twice the filled cross-section area.

data.part.dimensions.volumenumberNo

Material volume of the part, computed from the tessellated B-rep. Accounts for holes, chamfers, notches, and tapers — not a simple ProfileArea × Length approximation.

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",
      "linearPartType": "string",
      "linearPartSubType": "string",
      "dimensions": {
        "crossSectionalDimensions": {
          "dim1": 0.1,
          "dim2": 0.1,
          "dim3": 0.1,
          "dim4": 0.1,
          "size": 0.1,
          "height": 0.1,
          "width": 0.1,
          "diameter": 0.1,
          "outsideDiameter": 0.1,
          "insideDiameter": 0.1,
          "wallThickness": 0.1,
          "thickness": 0.1,
          "webThickness": 0.1,
          "flangeWidth": 0.1,
          "flangeThickness": 0.1
        },
        "contours": 0,
        "internalLength": 0.1,
        "length": 0.1,
        "profileLength": 0.1,
        "surfaceArea": 0.1,
        "outsideSurfaceArea": 0.1,
        "insideSurfaceArea": 0.1,
        "internalSurfaceArea": 0.1,
        "crossSectionalSurfaceArea": 0.1,
        "volume": 0.1
      }
    }
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}