BIM File Workspace properties

Summary

The Describe function returns the following properties for a BIM file workspace. The Dataset property group is also supported.

For a BIM file workspace, the Describe function's dataType property returns a value of "BIMFileWorkspace".

Properties

PropertyExplanationData Type
activeWorldFilePath
(Read Only)

The path to a .wld3 file that will be used to adjust the spatial coordinates of features in the file.

String
author
(Read Only)

The BIM file author's name.

String
bimLevels
(Read Only)

The BIM level names that will be returned as a JSON array of JSON objects.

String
buildingName
(Read Only)

The building name.

String
client
(Read Only)

The user-provided name of the organization for which the file was created.

String
designOptions
(Read Only)

A flat JSON array for design options that includes the design option name, whether the option is a primary option, and the name of the option set.

String
displayUnitSystem
(Read Only)

Specifies the display units, either Imperial or Metric.

String
externalSources
(Read Only)

A list of files referenced as a JSON array of a JSON object

String
isIFC
(Read Only)

Specifies whether the BIM workspace is an .ifc file.

Boolean
isRevit
(Read Only)

Specifies whether the BIM workspace is a Revit file.

Boolean
landTitle
(Read Only)

The land title.

String
lengthDisplayUnit
(Read Only)

The length display unit.

String
organizationName
(Read Only)

The organization name.

String
organizationDescription
(Read Only)

The organization description.

String
phases
(Read Only)

A list of construction phases that will be returned as a JSON array of JSON objects.

String
projectAddress
(Read Only)

The location address of the project.

String
projectName
(Read Only)

The name of the project.

String
projectNumber
(Read Only)

The project number.

String
projectStatus
(Read and Write)

The project status.

String
version
(Read Only)

The BIM file version.

String
worksets
(Read Only)

A list of workset names that will be returned as a JSON array of JSON objects.

String

Code sample

BIM File Workspace properties example

The following stand-alone script displays properties for a BIM file workspace.

import arcpy 

# Create a describe object # 
desc = arcpy.Describe("C:/data/project.ifc")

# Print BIM file Workspace properties
print(f"Is a Revit file: {desc.isRevit}")
print(f"Is an IFC file:  {desc.isIFC}")
print(f"Building Name:   {desc.buildingName}")
print(f"Client's Name:   {desc.client}")