Skip to main content
GET
/
utils
/
{resource_type}
/
{resource_uri}
/
metadata
Get metadata by FQN
curl --request GET \
  --url https://api.example.com/utils/{resource_type}/{resource_uri}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Project-ID: <x-project-id>'
{
  "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": [
    "<unknown>"
  ],
  "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>"
  ]
}

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

Query Parameters

​
fqn
string
required

Fully qualified name of the entity

​
asset_type
enum<string> | null

Expected asset type (for validation) Asset type discriminator values.

Available options:
database,
database_schema,
table,
column
​
version
string | null

Specific version to retrieve (e.g., '0.10'). Cannot be combined with include_children=true.

Pattern: ^\d+\.\d+$
​
include_children
boolean
default:false

Include direct child entities (max 500). Check children_total to detect truncation.

Response

Successful Response

Response schema for metadata assets.

​
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
​
display_name
string | null
​
description
string | null
​
summary_text
string | null
​
service_name
string | null
​
owners
OwnerSchema · object[] | null
​
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
​
children
any[] | 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
​
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.

​
change_summary
Change Summary · object
​
changed_by
string[] | null