Query Structures Web Service

From FMR Knowledge Base
Revision as of 14:42, 20 January 2021 by Glenn (talk | contribs) (Headers)
Jump to navigation Jump to search

Overview

Fusion Metadata Registry provides a web service for querying structural metadata which conforms to the SDMX specification.

Some additional Accept header values and query parameters are also supported both of which are explained in this guide.

Entry Point /ws/public/sdmxapi/rest/
Access Secure Public
Authentication None
Http Method GET
Response Format Multiple SDMX formats supported which can be specified wither using the HTTP Accept header or the 'format' URL parameter
Response Statuses

200 - Success

404 - Structure not found

500 - Server Error

Error Response SDMX-ML 2.1 Error Response Document

Headers

HTTP Header Purpose Allowed Values
Accept To define the response format
  • application/vnd.sdmx.structure+edi
  • application/vnd.sdmx.structure+xml;version=1.0
  • application/vnd.sdmx.structure+xml;version=2.0
  • application/vnd.sdmx.structure+xml;version=2.1
  • application/vnd.sdmx.json
Accept-Language

This optional header can be used to set the locale to return any multilingual text in (names and descriptions). If the text does not exist in the specified locale, then the default rules will be applied to find the next best appropriate locale.

Examples:
Accept-Language : en (English)
Accept-Language : fr (French)
Accept-Language : * (all languages – no filter)
Accept-Language : all (all languages – no filter)