---
title: "Import Preview"
method: POST
path: "/v1/ifc-import/import-preview/{stored_name}"
tags: ["ifc-import"]
---

# Import Preview

`POST /v1/ifc-import/import-preview/{stored_name}`

## Request

- Base URL: `https://api.shapemaker.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.shapemaker.io/v1/ifc-import/import-preview/{stored_name}`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

## Path parameters

- `stored_name` string, required

## Query parameters

- `structure_id` string, required

## Response `200`

Successful Response

- IfcImportPreviewView
  - `ancillaries` ImportStructureDiscreteAncillariesPreviewView[], required
    - `rowNumber` integer, required
    - `structureDiscreteAncillary` StructureDiscreteAncillaryParsedView, required
      - `tenantName` string, nullable
      - `mountHeightM` number, nullable, required
      - `azimuthDEG` number, nullable, required
      - `mountOption` 'TOP' | 'MIDDLE' | 'BOTTOM', required
      - `shieldingFactor` number, nullable, required
      - `mountBracketWeightKG` number, nullable
      - `shouldAnalyse` boolean
      - `xM` number, nullable
      - `yM` number, nullable
      - `status` 'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL', required
    - `discreteAncillaryMatches` DiscreteAncillaryView[], required
      - `id` integer, required
      - `name` string, required
      - `ancillaryType` string, required
      - `weightKG` number, required
      - `defaultMountOption` string, required
      - `geometries` DiscreteAncillaryGeometryView[], required
        - `geometryType` string, required
        - `geometryValue` number, required
      - `organizationId` integer, required
      - `powerDetails` DefaultPowerDetailsView
        - `powerConsumptionKW` number, required
      - `forceCoefficients` ForceCoefficientsView, required
        - `front` number, nullable, required
        - `side` number, nullable, required
        - `rear` number, nullable, required
      - `epa` EpaView
        - `frontM2` number, required
        - `sideM2` number, required
        - `rearM2` number, required
        - `governingM2` number, nullable: The EPA (m²) in the governing wind direction, if available.
    - `discreteAncillaryImportData` ParsedDiscreteAncillaryDataView, required
      - `name` string, required
      - `ancillaryType` string, nullable, required
      - `weightKG` number, nullable
      - `geometries` DiscreteAncillaryGeometryView[]
        - `geometryType` string, required
        - `geometryValue` number, required
    - `problems` ParsingProblemView[], required
      - `type` 'error' | 'warning', required
      - `message` string, required
  - `mounts` IfcMountCandidateView[], required
    - `name` string, required
    - `members` IfcMountMemberCandidateView[], required
      - `p1` IfcMountPointView, required
        - `x` number, required
        - `y` number, required
        - `z` number, required
      - `p2` IfcMountPointView, required
        - `x` number, required
        - `y` number, required
        - `z` number, required
      - `crossSectionId` string, required
      - `orientationDeg` number
      - `memberType` 'Leg1' | 'Diagonal1' | 'Diagonal2' | 'Horizontal1' | 'Horizontal2' | 'Secondary1' | 'Secondary2' | 'Secondary3' | 'Secondary4' | 'Hip1' | 'Hip2' | 'Hip3' | 'Hip4' | 'Plan1' | 'Plan2' | 'Plan3' | 'Plan4' | 'GuyWire' | 'MonopoleLeg' | 'RigidArm' | 'SingleLeg' | 'RooftopBeam' | 'MountMember'
      - `secondary` boolean
    - `supportPoints` IfcMountPointView[], required
      - `x` number, required
      - `y` number, required
      - `z` number, required
    - `elevationBottomM` number, required
    - `elevationTopM` number, required
    - `warnings` string[], required
    - `towerOrientationDeg` number, nullable
    - `towerLegCount` integer, nullable
    - `towerOffsetXM` number, nullable
    - `towerOffsetYM` number, nullable
  - `ancillaryMountLinks` IfcAncillaryMountLinkView[], required
    - `rowIndex` integer, required
    - `candidateIndex` integer, required
    - `memberIndex` integer, required
    - `positionAlongMemberMm` number, required
    - `offsetXMm` number, required
    - `offsetYMm` number, required
    - `offsetZMm` number, required
  - `averageTowerOrientationDeg` number, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/shapemaker/apis/shapemaker-api.md) - [All operations](https://skmtc.dev/shapemaker/apis/shapemaker-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shapemaker/apis/shapemaker-api/revisions/b8461cf1236c?raw)