Skip to main content

Entity Columns and Fields

OpenMetadata 2.1 adds paginated endpoints for inline child fields that previously required retrieving the complete parent entity.

List Fields for an Entity

All seven endpoints use GET and identify the parent by fully qualified name: Each endpoint accepts the same query parameters:
The response is a ResultList: data contains the requested children and paging.total contains the total matching count.

Update a Field

Use PUT /v1/columns/name/{fqn} to update an inline child of a supported parent:
Descriptions and tags apply to every supported type. displayName applies to every type except ML-model features. Constraints are specific to table columns, and custom-property extensions are supported for table and dashboard-data-model columns.

Column Grid

Use GET /v1/columns/grid to list unique columns across entities, with occurrences that share a name grouped by their metadata. It uses cursor-based pagination. metadataStatus is the status of the column across all of its occurrences:
  • MISSING: No description and no tags.
  • INCOMPLETE: A description or tags, but not both.
  • COMPLETE: Both a description and tags.
  • INCONSISTENT: The occurrences disagree on description or tags.
The status, hasConflicts, and hasMissingMetadata filters run on the grouped rows before pagination. A status filter returns only rows with that status, and the page size and totals match the filtered result.