yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-04 21:32:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.10.x-SNAPSHOT/main-concepts/metadata-standard/schemas/api/data/updateColumn.md
Aniket Katkar f224d4295e
Update docs for 1.9.0 (#22895)
2025-08-12 13:29:42 +05:30

1.5 KiB
Raw Blame History

title slug
updateColumn /main-concepts/metadata-standard/schemas/api/data/updatecolumn

UpdateColumn

Update Column API request to update individual column metadata such as display name, description, tags, and glossary terms. This API works for columns in both tables and dashboard data models using the column's fully qualified name. The constraint field is only applicable to table columns.

Properties

  • displayName (string): Display Name that identifies this column name.
  • description: Description of the column. Refer to ../../type/basic.json#/definitions/markdown.
  • tags (array): Tags and glossary terms associated with the column. Use source: 'Classification' for classification tags and source: 'Glossary' for glossary terms. Provide an empty array to remove all tags. Note: Invalid or non-existent tags/glossary terms will result in a 404 error. Default: None.
    • Items: Refer to ../../type/tagLabel.json.
  • constraint: Column level constraint. Only applicable to table columns, ignored for dashboard data model columns. Refer to ../../entity/data/table.json#/definitions/constraint.
  • removeConstraint (boolean): Set to true to remove the existing column constraint. Only applicable to table columns, ignored for dashboard data model columns. If both 'constraint' and 'removeConstraint' are provided, 'removeConstraint' takes precedence. Default: False.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.