Last updated 21/07/2026
Overview
The
DIQ_Result
type represents the outcome of an operation performed between the host application and DimensionIQ.
It provides a simple, consistent response contract that allows the host application to communicate whether an operation completed successfully and, if required, provide
additional contextual information.
DIQ_Result
is commonly returned from host application callbacks that perform persistence, validation, authorization, or other application specific processing.
DimensionIQ uses the returned result to determine whether the requested operation completed successfully or whether the operation should be considered failed.
By standardizing callback responses using
DIQ_Result
, DimensionIQ provides predictable integration behaviour and consistent error handling across all
host application implementations.
Properties
| Property | Type | Required | Description |
|---|
ok | boolean | Yes | Indicates whether the operation was successful, true , or failed, false |
message | string | No | Optional contextual message - used for error details, validation feedback, or informational notes |
Implementation Guidelines
Returning Results
DIQ_Result
objects should be returned by the host application whenever requested by a DimensionIQ callback.
The host application is responsible for constructing and returning the
DIQ_Result
object based on the outcome of its own processing, such as persisting
data, validating business rules, performing authorization checks, or interacting with external services.
A
DIQ_Result
should always be returned. Callbacks should not return null or undefined.
Successful Operations
When the
ok
property is true
, the operation is considered successful and DimensionIQ will continue normal processing.
The
message
property is optional and may be omitted when no additional information needs to be communicated.
Failed Operations
When the
ok
property is false
, the operation is considered unsuccessful.
The optional message property may be used to provide additional information describing why the operation failed. Depending on the callback and operation being performed,
DimensionIQ may display this message to the user or use it to assist with diagnostics.
Expected validation or business rule failures should be communicated by returning
ok
as false
rather than by throwing
exceptions.
Message Usage
The
message
property is intended to provide human readable information about the result of an operation.
Typical uses include validation feedback, authorization failures, persistence errors, or other contextual information that may assist users or developers in understanding the
outcome of the operation.
The format and content of the
message
are determined by the host application.