DIQ_Revision

Last updated 21/07/2026

Overview

The

DIQ_Revision

type represents a specific revision within a DimensionIQ project.

It contains the metadata required to identify and organize revision controlled project data, allowing DimensionIQ to maintain separate versions of drawings, layouts, dimension groups, and measurements throughout the lifecycle of a project.

DIQ_Revision

objects are created and maintained by DimensionIQ. The values contained within the object are generated and managed by DimensionIQ and should be treated as read-only by the host application.

The host application is responsible for persisting

DIQ_Revision

records within its preferred storage system, such as a database, file storage, or object storage service. When DimensionIQ creates or updates a revision, the complete object should be stored or updated using the values supplied by DimensionIQ.

The host application may use the persisted revision data for application specific workflows including revision management, reporting, auditing, estimating, project tracking, and integration with external project management or document control systems.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the revision, used for referencing and persistence
projectKey	string	Yes	Identifies the parent project this revision belongs to, must match an existing DIQ_Project key
number	number	Yes	Numeric revision sequence (eg, 1, 2, 3), used for ordering and version tracking
name	string	Yes	Display name for the revision (eg, "Revision A", "Tender Issue")
notes	string	No	Optional descriptive notes explaining the purpose or changes within the revision

Implementation Guidelines

Data Persistence

DIQ_Revision

objects should be persisted by the host application exactly as provided by DimensionIQ.

The host application is responsible for selecting and maintaining its own storage mechanism. This may include relational databases, document databases, file storage, object storage, or any other persistence solution appropriate for the application.

The host application should not create, calculate, or modify

DIQ_Revision

values directly. DimensionIQ is responsible for generating and maintaining the revision information contained within the object.

An exception exists when using Host-Controlled Revision Creation (see below), where the host application initiates the revision creation workflow.

When a new

DIQ_Revision

is received from DimensionIQ, the host application should persist the object. When an updated object is received, the existing stored record should be updated using the values supplied by DimensionIQ.

Revision Relationships

The

projectKey

property identifies the project that owns the revision and should be persisted exactly as provided by DimensionIQ.

The

key

property uniquely identifies the revision, while the

number

property defines its logical sequence within the project.

These values should be preserved to maintain the relationship between revisions and the associated project data.

Revision Metadata

The

name

property provides the primary user-facing identifier for the revision.

The optional

notes

property may be used to store descriptive information relating to the revision and may be consumed by the host application for reporting, revision history, auditing, or other application specific workflows.

Host-Controlled Revision Creation

By default, revisions are created by DimensionIQ.

When the

createRevision

capability is enabled, revision creation is delegated to the host application and the Add Revision option is hidden within the DimensionIQ user interface.

See the

DIQCapabilities

chapter for details on implementing host-controlled revision creation.

Read-Only Behavior

All

DIQ_Revision

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

The host application may read and use the stored revision information for its own workflows but should not modify identifiers, project relationships, revision numbering, or other DimensionIQ managed metadata.

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

DIQ_Revision

object to the host application for persistence.