Skip to content

DataItem

Data items belong to data objects. They describe the individual elements, such as the columns in a table or headers in a file. A Data Item can also represent a query expression (a calculated column) by setting QueryCode and optionally QueryLanguage.

Source of truth: DataItem.cs

JSON nameTypeDescription
idstringIdentifier as a string value to allow various identifier approaches.
namestringThe mandatory name of the Data Item.
dataTypestringThe data type of the Data Item (e.g. VARCHAR, int, text).
characterLengthintThe character length for text-typed Data Items.
numericPrecisionintThe numeric precision (total digits).
numericScaleintThe numeric scale (digits to the right of the decimal point).
ordinalPositionintThe ordinal position of this item within its parent Data Object.
isPrimaryKeyboolIndicates whether this item is part of a Primary Key.
isNullableboolIndicates whether this item accepts null values.
queryCodestringWhen set, the Data Item represents a query expression (a calculated column) rather than a stored column.
queryLanguagestringThe language that QueryCode is written in (e.g. SQL).
classificationsarray of DataClassificationFree-form and optional classification for the Data Item for use in generation logic (evaluation).
extensionsarray of ExtensionThe collection of extension Key/Value pairs.
notesstringFree-format notes.