API Reference › core-common› IModels › BriefcaseConnectionProps

BriefcaseConnectionProps Interface

The properties returned by the backend when creating a new BriefcaseConnection from the frontend with Ipc. These properties describe the iModel held on the backend for thew newly formed connection and are used to construct a new BriefcaseConnection instance on the frontend to access it.

Extends

Properties

Name Type Description
briefcaseId Readonly number | undefined The ID of the briefcase.  

Inherited properties

Name Type Inherited from Description
changeset Readonly Inherited ChangesetIdWithIndex | undefined IModelConnectionProps Id of the last Changeset that was applied to the iModel - must be defined for briefcases that are synchronized with iModelHub.
ecefLocation Readonly Inherited EcefLocationProps | undefined IModelConnectionProps The location of the iModel in Earth Centered Earth Fixed coordinates.
geographicCoordinateSystem Readonly Inherited GeographicCRSProps | undefined IModelConnectionProps The Geographic Coordinate Reference System indicating the projection and datum used.
globalOrigin Readonly Inherited XYZProps | undefined IModelConnectionProps An offset to be applied to all spatial coordinates.
iModelId Readonly Inherited string | undefined IModelConnectionProps Guid of the iModel.
iTwinId Readonly Inherited string | undefined IModelConnectionProps The iTwin in which the iModel exists - must be defined for briefcases that are synchronized with iModelHub.
key Readonly Inherited string IModelConnectionProps Unique key used for identifying the iModel between the frontend and the backend
name Readonly Inherited string | undefined IModelConnectionProps The name of the iModel.
projectExtents Readonly Inherited Range3dProps | undefined IModelConnectionProps The volume of the entire project, in spatial coordinates
rootSubject Readonly Inherited RootSubjectProps IModelConnectionProps The name and description of the root subject of this iModel

Defined in

Last Updated: 10 March, 2026