Get the canonical field catalog

GET

/v1/catalogs/fields

const url = 'http://localhost:8080/v1/catalogs/fields';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/v1/catalogs/fields

Returns the canonical field catalog (the read-only fields.catalog setting) as JSON: the fields extraction and the rules engine work with, used by the workstation for labels. Any staff role or an API key with status:read.

Responses

200

OK

application/json

Example^generated

example