DIQ_Variable

Last updated 21/07/2026

Overview

The

DIQ_Variable

type represents a reusable variable that can be referenced within formulas in DimensionIQ.

It contains the metadata required to define a variable, including its

name

,

type

, and

value

. Unlike

DIQ_Constant

objects, which are global across all projects,

DIQ_Variable

objects belong to a specific project and are organized within a

DIQ_VariableFolder

hierarchy.

Variables may store different types of values, including numbers, booleans, and lists. When the variable type is a

list

, the

list

property contains a JSON string representing the available values for that variable. The format of this JSON is managed internally by DimensionIQ and is not intended to be interpreted or modified by the host application.

DIQ_Variable

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_Variable

records using the values supplied by DimensionIQ and may use them for application specific workflows including reporting, configuration displays, exports, and integration with external business systems.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the variable
variableFolderKey	string	Yes	References the DIQ_VariableFolder used to organize this variable
name	string	Yes	Display name of the variable
type	string	Yes	The variable type, such as number , boolean , or, list
list	string	No	JSON string containing the available values when the variable type is list
value	string	Yes	The current value of the variable

Implementation Guidelines

Data Persistence

DIQ_Variable

objects should be persisted exactly as provided by DimensionIQ.

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

Variable Folder Relationship

The

variableFolderKey

property identifies the

DIQ_VariableFolder

that contains the variable.

This relationship should be preserved exactly as provided by DimensionIQ to maintain the organization of variables within the project folder hierarchy.

Variable Types

The

type

property defines the kind of value stored by the variable.

Variables may represent numeric values, boolean values, or lists. When the variable type is

list

, the

list

property contains a JSON representation of the available values.

The structure of this JSON is an internal implementation detail of DimensionIQ. The host application should persist and retrieve the

list

property exactly as provided and should not attempt to interpret, validate, or modify its contents.

Read-Only Behavior

All

DIQ_Variable

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

The host application may read and use stored variables but should not modify:

• The identifier -
  key
• The folder relationship -
  variableFolderKey
• The variable name -
  name
• The variable type -
  type
• The list definition -
  list
• The variable value -
  value

Any changes to variables should be performed through DimensionIQ.