Skip to main content

DIQ_Zone

Last updated 21/07/2026

Overview

The

DIQ_Zone
type represents a zone that can be assigned to dimensions within a
DIQ_Project
.

Zones are stored as a flat list scoped to the current project rather than as a folder hierarchy. Dimensions reference zones through their

zone1Key
,
zone2Key
,
zone3Key
, and
zone4Key
properties, allowing a single dimension to be associated with up to four zones.

Zones provide a mechanism for classifying dimensions into logical categories such as Levels, Fire Ratings, Areas, or other project specific groupings. Each zone belongs to a zone group, identified by the

groupNumber
property.

A dimension may have up to four zone assignments, with one zone selected from each group. For example, a project may define a Level group containing Level 1, Level 2, and Level 3, allowing a dimension to be assigned to a single level while also being assigned zones from other groups such as Fire Rating or Building Area.

DIQ_Zone
objects are created and maintained by DimensionIQ and should be treated as read-only by the host application.

The host application is responsible for persisting

DIQ_Zone
records using the values supplied by DimensionIQ and may use them to display zone information, provide filtering, reporting, exports, and other application specific workflows.

Properties

PropertyTypeRequiredDescription
key
string
YesUnique identifier for the zone
projectKey
string
YesReferences the
DIQ_Project
that owns the zone
groupNumber
number
YesIdentifies the zone group that the zone belongs to
name
string
YesDisplay name of the zone
dateAdded
string
NoDate and time the zone was created
dateModified
string
NoDate and time the zone was last modified

Implementation Guidelines

Data Persistence

DIQ_Zone
objects should be persisted exactly as provided by DimensionIQ.

The host application should not create or modify zone definitions. When a new zone is received it should be persisted, and when an updated zone is received the existing record should be updated using the values supplied by DimensionIQ.

Project Relationship

The

projectKey
property identifies the
DIQ_Project
that owns the zone.

Zones are project specific and should remain associated with the project that created them. The host application should preserve this relationship exactly as provided by DimensionIQ.

Zone Groups

The

groupNumber
property identifies the group that a zone belongs to.

Multiple

DIQ_Zone
objects may share the same
groupNumber
, representing the available values within that group. For example, a group representing building levels may contain zones such as Level 1, Level 2, and Level 3.

A dimension may have up to four zone assignments, with a maximum of one zone selected from each group.

The host application is not responsible for interpreting the meaning of zone groups or enforcing assignment rules. These are managed by DimensionIQ.

Read-Only Behavior

All

DIQ_Zone
properties should be considered read-only from the perspective of the host application.

The host application may read and use stored zones for display, filtering, reporting, and other application specific workflows but should not modify:

  • The identifier -
    key
  • The associated project -
    projectKey
  • The group number -
    groupNumber
  • The zone name -
    name
  • The creation date -
    dateAdded
  • The modification date -
    dateModified

Any changes to zones should be performed through DimensionIQ, which will provide the updated

DIQ_Zone
object to the host application for persistence.