Get table metadata

Get catalog metadata for tables

GET /api/v1/projects/{projectUuid}/dataCatalog/{table}/metadata

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "joinedTables": [
      "<string>"
    ],
    "fields": [
      {
        "name": "<string>",
        "label": "<string>",
        "tableLabel": "<string>",
        "owner": {
          "email": "<string>",
          "lastName": "<string>",
          "firstName": "<string>",
          "userUuid": "<string>"
        },
        "aiHints": [
          "<string>"
        ],
        "icon": {
          "unicode": "<string>"
        },
        "categories": [
          {
            "name": "<string>",
            "color": "<string>",
            "tagUuid": "<string>",
            "yamlReference": "<string>"
          }
        ],
        "tableName": "<string>",
        "type": "field",
        "catalogSearchUuid": "<string>",
        "description": "<string>",
        "requiredAttributes": {},
        "anyAttributes": {},
        "spotlightDefaultFilter": {
          "id": "<string>",
          "target": {
            "fieldRef": "<string>"
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true
        },
        "spotlightDefaultSegment": "<string>",
        "spotlightSegmentBy": [
          "<string>"
        ],
        "spotlightFilterBy": [
          "<string>"
        ],
        "searchRank": 123,
        "verifiedChartUsage": 123,
        "chartUsage": 123,
        "tags": [
          "<string>"
        ],
        "tableGroupLabel": "<string>"
      }
    ],
    "modelName": "<string>",
    "label": "<string>",
    "name": "<string>",
    "tableLabel": "<string>",
    "source": "<string>",
    "description": "<string>"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid · string · required

table · string · required

Table name to get metadata for

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok