Catalog

Read access to catalog objects and their attributes. limit bounds the result set: it defaults to 50 and may not exceed 200. There is no paging - narrow the search with the filters rather than walking pages. This matters on a real catalog, which can hold over a million attributes.

Leaving connections empty searches every connection. Custom field values are returned on every result in the same form the CSV and Excel exports use.

An object's id is null when the object is known from metadata but has no catalog entry yet, which is the normal state until someone edits it. Such objects carry no labels or custom fields either. The folder field is the object's catalog (dataset) folder path, which is a different tree from the glossary and is not comparable to a term's glossary.

Search objects

/api/v1/catalog/objects/search

Returns catalog objects matching the given filters

Request parameters

{
  "connections": [
    "example"
  ],
  "schemas": [
    "example"
  ],
  "objectName": "example",
  "description": "example",
  "labels": [
    "example"
  ],
  "freeText": "example",
  "limit": 96
}

Responses

[
  {
    "id": 96,
    "connection": "example",
    "schema": "example",
    "name": "example",
    "description": "example",
    "databaseRemark": "example",
    "folder": "example",
    "labels": [
      "example"
    ],
    "columnCount": 96,
    "rowCount": "example",
    "freshness": "example",
    "lastSync": "example",
    "testCaseCount": 96,
    "testCasePassed": 96,
    "testCaseFailed": 96,
    "testCaseError": 96,
    "testCaseNotExecuted": 96,
    "customFields": [
      {
        "name": "example",
        "values": [
          "example"
        ]
      }
    ]
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

Search attributes

/api/v1/catalog/attributes/search

Returns catalog attributes (columns) matching the given filters

Request parameters

{
  "connections": [
    "example"
  ],
  "schemas": [
    "example"
  ],
  "object": "example",
  "attributeName": "example",
  "dataType": "example",
  "description": "example",
  "freeText": "example",
  "limit": 96
}

Responses

[
  {
    "id": 96,
    "connection": "example",
    "schema": "example",
    "object": "example",
    "name": "example",
    "dataType": "example",
    "description": "example",
    "databaseRemark": "example",
    "primaryKey": true,
    "nullable": true,
    "defaultValue": "example",
    "terms": [
      "example"
    ],
    "qualityPercentage": 16.0,
    "testCaseCount": 96,
    "customFields": [
      {
        "name": "example",
        "values": [
          "example"
        ]
      }
    ]
  }
]

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

{
  "status": 96,
  "message": "example",
  "errors": [
    {
      "entityId": "example",
      "field": "example",
      "message": "example"
    }
  ]
}

09 October 2026