Skip to content

BIM Properties

The properties object (serialized as dsProps in some contexts) contains comprehensive metadata specific to the application logic and BIM data.

Properties Object

KeyTypeDescription
typeStringThe classification of the element (e.g., "Wall", "Slab").
keepSourceMeshBooleanWhether to preserve the original mesh data.
editedBooleanIndicates if the element has been modified.
isLockedBooleanWhether the element is locked from editing.
isSelectedBooleanSelection state.
isHeightLockedBooleanWhether the height property is constrained.
revitMetaDataObjectRevit-specific data including path and parameters.
areasObjectCalculated areas (e.g., bottomFace).
costNumberBase cost value.
constructionCostObjectBreakdown of construction costs.
changeDataObjectTracking for changes in volume, area, length, etc.
propertiesObjectDetailed material and layer properties (see below).
structure_idStringID of the parent structure.
storeyNumberStorey index.
quantitativeDataObjectGeometric quantities (area, volume, running length).
slopeNumberSlope value.
profileNumberProfile identifier.
idStringElement unique identifier (e.g., "wl_z4ww48gox").
room_idStringID of the room this element belongs to.
thicknessNumberElement thickness.
brepStringSerialized B-Rep (Boundary Representation) data.

Nested Property Objects

Properties (Material/Layer Data)

KeyTypeDescription
typeStringMaterial type description (e.g., "Exposed concrete").
layersArrayList of material layers.
thicknessNumberTotal thickness.
purposeStringUsage classification (e.g., "External").
versionNumberVersion number.

Layer Definition

KeyTypeDescription
nameStringLayer name.
thicknessNumberLayer thickness.
materialObjectMaterial reference (type, name).
typeStringLayer function (e.g., "Structure").
thicknessTypeStringType definition (e.g., "Regular").
isCoreBooleanWhether this is a core layer.

Quantitative Data

KeyTypeDescription
areaObjectArea breakdown (bottom, lateralSurface, largest).
runningLengthNumberLinear length of the element.
volumeNumberVolume of the element.

Example Snippet

json
"dsProps": {
  "type": "Wall",
  "isLocked": false,
  "isHeightLocked": true,
  "revitMetaData": {
    "path": "",
    "parametricExportSupportStatus": "NOT_CHECKED"
  },
  "properties": {
    "type": "Exposed concrete",
    "layers": [
      {
        "name": "Concrete",
        "thickness": 0.8,
        "material": { "type": "Concrete", "name": "Concrete_Grooved.jpg" },
        "type": "Structure",
        "isCore": false
      }
    ],
    "thickness": 1.6,
    "purpose": "External"
  },
  "quantitativeData": {
    "area": { "bottom": 48.6, "lateralSurface": 346.5 },
    "volume": 554.4
  },
  "height": 12
}