Skip to main content

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

Property Explanation Data 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 and floor 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}")