The default FAIR catalogue schema is based on the core W3C DCAT catalogue. For users that require an extended catalogue we provide two endpoints that allow them to edit their catalogue templates.
Permissions
Users need to be granted permission to edit catalogue templates. These are applied to the user's access token.
This page details how users can obtain an access token to query the API.
Admin users can add additional permissions to a user's access token by selecting 'API Tokens' from the Administer menu, and then selecting the token they wish to add permissions to.
The permissions for editing catalogue templates are:
- The token can create catalogue definitions for use in datasets
- The token can view all catalogue definitions
- The token can modify which catalogue fields will be used when creating datasets
- The token can delete catalogue definitions
Endpoints
Editing of templates is via the new templates/catalogues/ endpoint. Updating catalogue templates does not impact existing metadata or data until validation is enforced.
Catalogue templates are defined using a JSON specification and support a variety of data types: text, string, date, markdown, boolean, number, list, object (a set of fields). Fields can also have default values or be marked as required.
A validation endpoint PUT /templates/catalogues/{code}/schema is provided to test a catalogue JSON object against the schema for a specific catalogue template (identified by {code}).