Sign in
Catalog

Show dataset information

Returns a list of available endpoints for the specified dataset, with metadata and endpoints.

The response includes the following links:

  • the attachments endpoint
  • the files endpoint
  • the records endpoint
  • the catalog endpoint.
get/catalog/datasets/{dataset_id}

Path parameters

dataset_idstring required

The identifier of the dataset to be queried.

You can find it in the "Information" tab of the dataset page or in the dataset URL, right after /datasets/.

Query parameters

selectstring

Examples:

  • select=size - Example of select, which only return the "size" field.
  • select=size * 2 as bigger_size - Example of a complex expression with a label, which returns a new field named "bigger_size" and containing the double of size field value.
  • select=dataset_id, fields - Example of a select in catalog ODSQL query to only retrieve dataset_id and schema of datasets.

A select expression can be used to add, remove or change the fields to return. An expression can be:

  • a wildcard ('*'): all fields are returned.
  • A field name: only the specified field is returned.
  • An include/exclude function: All fields matching the include or exclude expression are included or excluded. This expression can contain wildcard.
  • A complex expression. The result of the expression is returned. A label can be set for this expression, and in that case, the field will be named after this label.
lang'en' | 'fr' | 'nl' | 'pt' | 'it' | 'ar' | 'de' | 'es' | 'ca' | 'eu' | 'sv'

A language value.

If specified, the lang value override the default language, which is "fr". The language is used to format string, for example in the date_format function.

timezonestring

Set the timezone for datetime fields.

Timezone IDs are defined by the Unicode CLDR project. The list of timezone IDs is available in timezone.xml.

Response

The dataset

Changes