Field

Type

Description

Possible Values

Example

iro

JSON Object

Root wrapper containing dataset objects

Dataset JSON object

{...}

iro.id

String

Unique system-generated identifier for the dataset. Used to reference this dataset in API calls, relationships, and semantic models

Any valid system-generated ID string

"17764122062715127080024192718499"

iro.name

String

Human-readable display name of the dataset. This name appears in the UI and is used for identification. Must be unique within a folder.

Any non-empty string (unique within folder)

"reseller sales fact Table"

iro.type

String

Internal entity classification. Used by the system to distinguish datasets from other entity types.

"QUERY"

"QUERY"

iro.subType

String

Further classification of the entity. Set to "REGISTERED" for datasets that are registered in the repository and available for use in semantic models.

"REGISTERED"

"REGISTERED"

iro.categoryId

String

Identifier of the folder/category where this dataset resides. Used for organizing datasets hierarchically.

Valid folder ID string

"folder_17764121330929127010066120941822"

iro.folderId

String

Folder identifier (same value as categoryId). Represents the parent folder containing this dataset in the repository structure.

Valid folder ID string

"folder_17764121330929127010066120941822"

iro.folderName

String

Display name of the folder containing this dataset.

Any string (can be empty)

"", "Sales Reports"

iro.accessRights

String

Numeric code indicating the current user's permission level on this dataset.

-1 = DENIED ("Deny"),
0 = READ ("Read Only"),
1 = WRITE ("Read And Write"),
-2 = IMPLICIT_READ ("Implicit Read")

"1"

iro.ownerAppId

String

Unique identifier of the user who created or owns this dataset. Used for audit trails.

Valid user ID string or empty

"", "user_123456"

iro.ownerAppName

String

Username of the dataset owner. Displayed in UI for ownership attribution and contact purposes.

Any string

"John"

iro.repositDate

String

Human-readable timestamp of when this dataset was last modified. Format: MM/dd/yyyy HH:mm:ss z.

Date string in format MM/dd/yyyy HH:mm:ss z

"04/17/2026 13:21:19 IST"

iro.entityRepositDate

String

Unix epoch timestamp (milliseconds) of the last modification. Use this for programmatic date comparisons and sorting.

Numeric string (epoch milliseconds)

"1776412263470"

iro.isPublic

Boolean

Indicates whether this dataset is publicly accessible to all users in the system.

true, false

true

iro.linkedEntityId

String

ID of another entity this dataset is linked to (e.g., for derived or copied datasets).

Valid entity ID string or empty ""

"", "17764122062715127080024192718500"

iro.entityState

String

Current lifecycle state of the dataset.

"ACTIVE" - Entity is active,
"SUSPEND" - Entity is suspended

""

iro.designSource

String

Indicates how this dataset was created.

"DESIGNER", "KYVOS_DIALOG", "QUICK_DATA_MODELLER"

"DESIGNER"

iro.common.desc

String

Optional description providing context about the dataset's purpose, contents, or usage notes.

Any string (can be empty)

"", "Sales data for analysis"

iro.common.tags

String

Comma-separated list of tags for categorization and search.

Comma-separated string or empty

"", "sales,reseller,daily,finance"

iro.common.compatibilityVersion

String

Internal version number for backward compatibility. Used by the system to handle schema migrations.

Numeric string

"1"

iro.specific.qo.role

String

Defines how this dataset functions in semantic models.

"FACT", "DIMENSION"

"FACT"

iro.specific.qo.cached

Boolean

When true, query results are cached to improve performance on repeated access.

true, false

true

iro.specific.qo.connName

String

Name of the data connection used to access the underlying data source.

Valid connection name string

"DefaultHadoopCluster"

iro.specific.qo.connType

String

Type of connection protocol.

“ PARENT”

"PARENT"

iro.specific.qo.transformation.steps

Array

Ordered list of transformation steps that define the data pipeline.

Array of step objects

[{...}, {...}]

iro.specific.qo.transformation.steps[].id

String

Unique identifier for this transformation step.

System-generated ID string

"17764122063997964225"

iro.specific.qo.transformation.steps[].name

String

Display name of the step shown in the designer UI.

Any non-empty string

"Fetch", "Filter Active"

iro.specific.qo.transformation.steps[].type

String

Type of transformation operation.

"FETCH", "FILTER"

"FETCH"

iro.specific.qo.transformation.steps[].inputSteps

Array

List of step IDs that feed data into this step.

Array of step ID strings or empty []

[], ["17764122063997964225"]

iro.specific.qo.transformation.steps[].outputSteps

Array

List of step IDs that receive output from this step.

Array of step ID strings or empty []

[], ["17764122063997964230"]

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.source

String

Type of data source being fetched.

"HCATALOG","SQL","CSV","SEQ","PARQUET","EXCEL","ICEBERG"

"HCATALOG"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sourceSubType

String

Additional classification for the source type.

Empty "" or connector-specific value

""

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.connType

String

Connection inheritance mode.

"PARENT", "CUSTOM"

"PARENT"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.connName

String

Connection name for this fetch step.

Valid connection name string

"DefaultHadoopCluster"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.inputType

String

Specifies how data is retrieved from the source, supporting 3 possible values:

Table-Based: "Use this for TABLE inputType only"
SQL-Based: "Use this for SQL inputType only"
File-Based: "Use this for FILE inputType only"

"TABLE", "SQL", "FILE"

"TABLE"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.lookupEnabled

Boolean

When true, this dataset can be used as a lookup table in semantic model relationships.

true, false

true

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.isSorted

Boolean

Indicates if the source data is pre-sorted.

true, false

false

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.incrementalIdentifier.columnName

String

Column used to identify new/changed records for incremental processing.

"undefined" or valid column name

"undefined", "timestamp_col"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.hCatalogSource.dbName

String

Name of the Hive/HCatalog database containing the source table.

Valid database name string

"sales_db"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.hCatalogSource.table.content

String

Name of the Hive/HCatalog table to fetch data from.

Valid table name string

"factresellersales_adventure"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.hCatalogSource.tableType

String

Type of Hive table.

"TABLE”, "VIEW", "FILE"

""

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.tableName

String

Table name for partition-based parallel reads.

Valid table name string

"fact_sales"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.columnName

String

Numeric or date column used to partition data for parallel reads.

Valid column name string

"order_date_key"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.numberOfPartitions

String

Number of parallel partitions for reading data.

Numeric string (positive integer)

"10"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.numberOfRecords

String

Provide the maximum number of partitions to be used for parallel processing of table data. It also defines the maximum number of concurrent JDBC connections that will be triggered for computation.

Numeric string or empty ""

"", "1000000"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.metadataMode

String

How column metadata is retrieved.

“AUTO”,”MANUAL”

"DEFAULT"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.minValue

String

Specify the minimum value of the selected column to be considered for parallel processing. You can also select a parameter to specify the min value. Ensure that the data type is the same as the column selected above.

Numeric/date string or empty ""

"", "20200101"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.fetch.sparkJdbcDataPartitionColumn.maxValue

String

Specify the maximum value of the selected column to be considered for parallel processing. You can also select a parameter to specify the min value. Ensure that the data type is the same as the column selected above.

Numeric/date string or empty ""

"", "20261231"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns

Array

List of column definitions for this fetch step.

Array of column objects

[{...}, {...}]

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].name

String

Current working name of the column.

Valid column name string

"productkey"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].updatedName

String

Renamed column name if the user has modified it.

Valid column name string

"productkey", "product_id"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].originalName

String

Original column name as it exists in the source table/file.

Valid column name string

"productkey"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].dataTypeName

String

Logical data type category.

"NUMBER", "CHAR", "DATE"

"NUMBER"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].dataSubTypeName

String

Specific numeric subtype for NUMBER columns.

"long", "double", "float", "decimal", ""

"long"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].originalDataTypeName

String

JDBC type code from the source database.

JDBC type code: "4" (INTEGER), "8" (DOUBLE), "12" (VARCHAR) etc.

"12"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].pigDataType

Integer

Internal Pig/Spark data type code.

-5 (BIGINT), 1 (CHAR), 8 (DOUBLE), 91 (DATE)

-5

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].fieldDataFormatType

String

Format category code.

"1" (CHAR), "2" (NUMBER), "4" (DATE)

"2"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].fieldFormat.content

String

Format pattern or code applied to this column.

Format pattern string or empty

"", "#,##0.00", "yyyy-MM-dd"

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].fieldFormat.useDefault

String

When set, indicates the column uses the system default format.

"" (custom format), "true" (default format)

""

iro.specific.qo.transformation.steps[].stepInfo.fetchInfo.columns[].hidden

Boolean

When true, this column is excluded from the dataset output.