latestOpenAPI 3.1.02026-08-20118232229.3 KB

0e42b0fb26d9

List catalog facts

Lists the semantic metadata facts attached to a catalog, optionally filtered by scope and/or object path.

get/catalogs/{catalog}/facts

Path parameters

catalogstring required

The name of the catalog.

The name of the catalog.

Query parameters

environmentstring

The environment of the catalog. Note that if a catalog with the requested name doesn't exist in the requested environment, facts for the catalog with the same name from the default environment will be returned.

The environment of the catalog. Note that if a catalog with the requested name doesn't exist in the requested environment, facts for the catalog with the same name from the default environment will be returned.

scopestring

Filter facts by scope. When omitted, facts of every scope are returned.

Filter facts by scope. When omitted, facts of every scope are returned.

objectstring

Filter facts by object path (exact match). When omitted, facts about any object are returned.

Filter facts by object path (exact match). When omitted, facts about any object are returned.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

environmentstring required

Environment containing the catalog definition.

Example response

{
  "$schema": "https://api.tower.dev/v1/schemas/ListCatalogFactsResponse.json"
}