Skip to main content
GET
/
utils
/
{resource_type}
/
{resource_uri}
/
metadata
/
query
List metadata entities
curl --request GET \
  --url https://api.example.com/utils/{resource_type}/{resource_uri}/metadata/query \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Project-ID: <x-project-id>'
{
  "pagination": {
    "offset": 123,
    "limit": 123,
    "total": 123
  },
  "results": [
    {
      "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

​
asset_type
enum<string> | null

Filter by asset type Asset type discriminator values.

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

Text search across name and description

​
fqn_prefix
string | null

FQN prefix for hierarchical scoping (direct children only)

​
sort_by
string
default:name

Sort field: name, created_at, ordinal_position

​
sort_order
string
default:asc

Sort order: asc or desc

​
limit
integer
default:50

Max results per page

Required range: 1 <= x <= 200
​
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

Successful Response

Paginated list response for metadata assets.

​
pagination
PaginationInfo · object
required

Pagination metadata.

​
results
MetadataAssetResponse · object[]
required