Columns

Update a column by fully qualified name

Update column metadata such as display name, description, tags, glossary terms, and other properties. This API works for columns in both tables and dashboard data models. The column is identified by its fully qualified name and the parent entity type is specified.

Tag Management Examples: • Add tags: {"tags": [{"tagFQN": "PersonalData.PII", "source": "Classification"}]} • Remove specific tag: {"tags": []} (specify only tags you want to keep) • Remove all tags: {"tags": []} • Mix classifications and glossary terms: {"tags": [{"tagFQN": "PII.Sensitive", "source": "Classification"}, {"tagFQN": "Glossary.CustomerData", "source": "Glossary"}]} • Don't change tags: omit the 'tags' field entirely

Validation Rules: • Invalid or non-existent tags/glossary terms will result in a 404 error • All tags and glossary terms must exist and be valid before the request succeeds

put/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)

Request body

displayNamestring
descriptionstring
constraint'NULL' | 'NOT_NULL' | 'UNIQUE' | 'PRIMARY_KEY'
removeConstraintboolean
extensionobject

Response

The updated 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.