Columns

Get a column by fully qualified name

Retrieve a single column by its fully qualified name. The parent entity type must be specified. Supports field projection via the 'fields' parameter (e.g. tags, customMetrics, extension, profile).

get/v1/columns/name/{fqn}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/columns/name/{fqn}
  • Auth: HTTP bearer

Path parameters

fqnstring required

Fully qualified name of the column

Query parameters

entityType'table' | 'dashboardDataModel' required

Entity type of the parent entity (table or dashboardDataModel)

fieldsstring
Example:tags,customMetrics,extension,profile

Fields to include in the response (comma-separated). Supported: tags, customMetrics, extension, profile

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

The column

namestring required
displayNamestring
dataType'NUMBER' | 'TINYINT' | 'SMALLINT' | 'INT' | 'BIGINT' | 'BYTEINT' | 'BYTES' | 'FLOAT' | 'DOUBLE' | 'DECIMAL' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMPZ' | 'TIME' | 'DATE' | 'DATETIME' | 'INTERVAL' | 'STRING' | 'MEDIUMTEXT' | 'TEXT' | 'CHAR' | 'LONG' | 'VARCHAR' | 'BOOLEAN' | 'BINARY' | 'VARBINARY' | 'ARRAY' | 'BLOB' | 'LONGBLOB' | 'MEDIUMBLOB' | 'MAP' | 'STRUCT' | 'UNION' | 'SET' | 'GEOGRAPHY' | 'ENUM' | 'JSON' | 'UUID' | 'VARIANT' | 'GEOMETRY' | 'BYTEA' | 'AGGREGATEFUNCTION' | 'ERROR' | 'FIXED' | 'RECORD' | 'NULL' | 'SUPER' | 'HLLSKETCH' | 'PG_LSN' | 'PG_SNAPSHOT' | 'TSQUERY' | 'TXID_SNAPSHOT' | 'XML' | 'MACADDR' | 'TSVECTOR' | 'UNKNOWN' | 'CIDR' | 'INET' | 'CLOB' | 'ROWID' | 'LOWCARDINALITY' | 'YEAR' | 'POINT' | 'POLYGON' | 'TUPLE' | 'SPATIAL' | 'TABLE' | 'NTEXT' | 'IMAGE' | 'IPV4' | 'IPV6' | 'DATETIMERANGE' | 'HLL' | 'LARGEINT' | 'QUANTILE_STATE' | 'AGG_STATE' | 'BITMAP' | 'UINT' | 'BIT' | 'MONEY' | 'MEASURE HIDDEN' | 'MEASURE VISIBLE' | 'MEASURE' | 'KPI' | 'HEIRARCHY' | 'HIERARCHYID' required
arrayDataType'NUMBER' | 'TINYINT' | 'SMALLINT' | 'INT' | 'BIGINT' | 'BYTEINT' | 'BYTES' | 'FLOAT' | 'DOUBLE' | 'DECIMAL' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMPZ' | 'TIME' | 'DATE' | 'DATETIME' | 'INTERVAL' | 'STRING' | 'MEDIUMTEXT' | 'TEXT' | 'CHAR' | 'LONG' | 'VARCHAR' | 'BOOLEAN' | 'BINARY' | 'VARBINARY' | 'ARRAY' | 'BLOB' | 'LONGBLOB' | 'MEDIUMBLOB' | 'MAP' | 'STRUCT' | 'UNION' | 'SET' | 'GEOGRAPHY' | 'ENUM' | 'JSON' | 'UUID' | 'VARIANT' | 'GEOMETRY' | 'BYTEA' | 'AGGREGATEFUNCTION' | 'ERROR' | 'FIXED' | 'RECORD' | 'NULL' | 'SUPER' | 'HLLSKETCH' | 'PG_LSN' | 'PG_SNAPSHOT' | 'TSQUERY' | 'TXID_SNAPSHOT' | 'XML' | 'MACADDR' | 'TSVECTOR' | 'UNKNOWN' | 'CIDR' | 'INET' | 'CLOB' | 'ROWID' | 'LOWCARDINALITY' | 'YEAR' | 'POINT' | 'POLYGON' | 'TUPLE' | 'SPATIAL' | 'TABLE' | 'NTEXT' | 'IMAGE' | 'IPV4' | 'IPV6' | 'DATETIMERANGE' | 'HLL' | 'LARGEINT' | 'QUANTILE_STATE' | 'AGG_STATE' | 'BITMAP' | 'UINT' | 'BIT' | 'MONEY' | 'MEASURE HIDDEN' | 'MEASURE VISIBLE' | 'MEASURE' | 'KPI' | 'HEIRARCHY' | 'HIERARCHYID'
dataLengthinteger
precisioninteger
scaleinteger
dataTypeDisplaystring
descriptionstring
fullyQualifiedNamestring
constraint'NULL' | 'NOT_NULL' | 'UNIQUE' | 'PRIMARY_KEY'
ordinalPositioninteger
jsonSchemastring
extensionobject

Changes

No recorded changes to this operation across all 1 revision of this API.