Skip to main content
POST
Store (upsert) metadata

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Project-ID
string
required

Path Parameters

resource_type
string
required
resource_uri
string
required

Body

application/json

Request body for storing metadata.

metadata
ColumnMetadata · object
required

Column metadata for store requests.

version_change_reason
string
required
Required string length: 1 - 500
version_bump_type
enum<string>
default:minor

Version bump type values.

Available options:
major,
minor
change_source
string | null

Source of change: manual, ai, automated, etc.

Maximum string length: 64

Response

Updated

Response for store metadata endpoint.

id
string
required
type
enum<string>
required

Asset type discriminator values.

Available options:
database,
database_schema,
table,
column
name
string
required
fully_qualified_name
string
required
resource_uri
string
required
organization_id
string
required
project_id
string
required
version
string
required
version_major
integer
required
version_minor
integer
required
version_change_reason
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string
required
updated_by
string
required
message
string
required

Status message: 'created', 'updated', or 'unchanged'

display_name
string | null
description
string | null
summary_text
string | null
service_name
string | null
owners
OwnerSchema · object[] | null
extension
Extension · object | null
schema_definition
string | null
deleted_at
string<date-time> | null
is_dq_tagged
boolean
default:false
is_pii_tagged
boolean
default:false
is_sensitivity_tagged
boolean
default:false
tags
TagRef · object[] | null
children
MetadataAssetResponse · object[] | null
children_total
integer | null

Total number of direct children. Compare with len(children) to detect truncation (max 500 returned).

table_type
string | null
row_count
integer | null
column_count
integer | null
table_count
integer | null
data_type
string | null
data_type_display
string | null
ordinal_position
integer | null
nullable
boolean | null
constraint
Constraint · object | null
column_relationships
Column Relationships · object[] | null
precision
integer | null
scale
integer | null
data_length
integer | null
business_definition
string | null
business_rules
string | null
change_description
ChangeDescription · object | null

Structured diff between consecutive versions.

change_summary
Change Summary · object | null
changed_by
string[] | null
children_summary
Children Summary · object | null

Created/updated counts per child type when nested children were provided