v1.Attribute

v1.Attribute.data_typeproperty

A column data type in the physical database.

data_type: "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";

v1.Attribute.default_viewproperty

An Id of the label to be used by default for this field

default_view?: string;

v1.Attribute.descriptionproperty

An optional description of the field.

description?: string;

v1.Attribute.is_hiddenpropertyDeprecated

Warning: This API is now obsolete.

Deprecated. Use ‘show_in_ai_results’ instead.

is_hidden?: boolean;

v1.Attribute.is_nullableproperty

Optional flag to indicate if the attribute can contain null values.

is_nullable?: boolean;

v1.Attribute.labelsproperty

labels?: {
        [k: string]: Label;
    };

v1.Attribute.localeproperty

locale?: Locale;

v1.Attribute.null_value_join_replacementproperty

Optional value which can be used as replacement for NULL in join conditions.

null_value_join_replacement?: string;

v1.Attribute.show_in_ai_resultsproperty

Optional flag to indicate if the attribute should be shown in AI results. When omitted, the attribute is visible.

show_in_ai_results?: boolean;

v1.Attribute.sort_columnproperty

A column name in the source table to do sorting by

sort_column?: string;

v1.Attribute.sort_directionproperty

sort_direction?: "ASC" | "DESC";

v1.Attribute.source_columnproperty

A column name in the physical database. Optional, equals to id by default.

source_column?: string;

v1.Attribute.tagsproperty

tags?: Tags1;

v1.Attribute.titleproperty

A human readable title of the field. Optional, derived from id if not provided explicitly.

title?: string;

v1.Attribute.typeproperty

type: "attribute";