Store (upsert) metadata

Create or update a metadata asset. The asset type is determined by the type discriminator field in the request body.

POST /utils/{resource_type}/{resource_uri}/metadata

Store (upsert) metadata

cURL

curl --request POST \
  --url https://api.example.com/utils/{resource_type}/{resource_uri}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Project-ID: <x-project-id>' \
  --data '
{
  "metadata": {
    "name": "<string>",
    "fully_qualified_name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "summary_text": "<string>",
    "type": "column",
    "data_type": "<string>",
    "data_type_display": "<string>",
    "ordinal_position": 123,
    "nullable": true,
    "constraint": {},
    "column_relationships": [
      {}
    ],
    "precision": 123,
    "scale": 123,
    "data_length": 123,
    "business_definition": "<string>",
    "business_rules": "<string>",
    "owners": [
      {
        "name": "<string>",
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "extension": {},
    "is_dq_tagged": true,
    "is_pii_tagged": true,
    "is_sensitivity_tagged": true,
    "version": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "version_change_reason": "<string>",
  "version_bump_type": "minor",
  "change_source": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "fully_qualified_name": "<string>",
  "resource_uri": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "version": "<string>",
  "version_major": 123,
  "version_minor": 123,
  "version_change_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "message": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "summary_text": "<string>",
  "service_name": "<string>",
  "owners": [
    {
      "name": "<string>",
      "type": "<string>",
      "id": "<string>"
    }
  ],
  "extension": {},
  "schema_definition": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "is_dq_tagged": false,
  "is_pii_tagged": false,
  "is_sensitivity_tagged": false,
  "tags": [
    {
      "tag_id": "<string>",
      "tag_fqn": "<string>",
      "category_name": "<string>",
      "tag_name": "<string>",
      "tag_description": "<string>"
    }
  ],
  "children": [
    {
      "id": "<string>",
      "name": "<string>",
      "fully_qualified_name": "<string>",
      "resource_uri": "<string>",
      "organization_id": "<string>",
      "project_id": "<string>",
      "version": "<string>",
      "version_major": 123,
      "version_minor": 123,
      "version_change_reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_by": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "summary_text": "<string>",
      "service_name": "<string>",
      "owners": [
        {
          "name": "<string>",
          "type": "<string>",
          "id": "<string>"
        }
      ],
      "extension": {},
      "schema_definition": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "is_dq_tagged": false,
      "is_pii_tagged": false,
      "is_sensitivity_tagged": false,
      "tags": [
        {
          "tag_id": "<string>",
          "tag_fqn": "<string>",
          "category_name": "<string>",
          "tag_name": "<string>",
          "tag_description": "<string>"
        }
      ],
      "children": null,
      "children_total": 123,
      "table_type": "<string>",
      "row_count": 123,
      "column_count": 123,
      "table_count": 123,
      "data_type": "<string>",
      "data_type_display": "<string>",
      "ordinal_position": 123,
      "nullable": true,
      "constraint": {},
      "column_relationships": [
        {}
      ],
      "precision": 123,
      "scale": 123,
      "data_length": 123,
      "business_definition": "<string>",
      "business_rules": "<string>",
      "change_description": {
        "fields_added": [
          {
            "field_name": "<string>"
          }
        ],
        "fields_updated": [
          {
            "field_name": "<string>"
          }
        ],
        "fields_deleted": [
          {
            "field_name": "<string>"
          }
        ],
        "previous_version": "<string>"
      },
      "change_summary": {},
      "changed_by": [
        "<string>"
      ]
    }
  ],
  "children_total": 123,
  "table_type": "<string>",
  "row_count": 123,
  "column_count": 123,
  "table_count": 123,
  "data_type": "<string>",
  "data_type_display": "<string>",
  "ordinal_position": 123,
  "nullable": true,
  "constraint": {},
  "column_relationships": [
    {}
  ],
  "precision": 123,
  "scale": 123,
  "data_length": 123,
  "business_definition": "<string>",
  "business_rules": "<string>",
  "change_description": {
    "fields_added": [
      {
        "field_name": "<string>"
      }
    ],
    "fields_updated": [
      {
        "field_name": "<string>"
      }
    ],
    "fields_deleted": [
      {
        "field_name": "<string>"
      }
    ],
    "previous_version": "<string>"
  },
  "change_summary": {},
  "changed_by": [
    "<string>"
  ],
  "children_summary": {}
}

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.

ColumnMetadata

TableMetadata

SchemaMetadata

DatabaseMetadata

Show child attributes

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

200

application/json

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

Show child attributes

extension · Extension · object

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

Show child attributes

children · MetadataAssetResponse · object[] | null

Show child attributes

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

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

Structured diff between consecutive versions.

Show child attributes

change_summary · Change Summary · object

Show child attributes

changed_by · string[] | null

children_summary · Children Summary · object

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

Show child attributes