Difference between revisions of "Query Structures Web Service"
(→Parameters) |
(→Additional parameter used for identifying a resource, for item scheme types) |
||
| Line 78: | Line 78: | ||
==== Additional parameter used for identifying a resource, for item scheme types ==== | ==== Additional parameter used for identifying a resource, for item scheme types ==== | ||
| − | SDMX uses the ''item scheme'' pattern to model SDMX collections of items. These are: | + | SDMX uses the ''item scheme'' pattern to model SDMX collections of items. These are principally: |
* categoryscheme | * categoryscheme | ||
* conceptscheme | * conceptscheme | ||
* codelist | * codelist | ||
| − | + | ... and others concerning organisation schemes and VTL transformations.<br> | |
| − | + | A complete list can be found in the [[REST_API_Overview#Additional_parameter_used_for_identifying_a_resource.2C_for_item_scheme_types|REST API Overview]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Although it is not following the ''item scheme'' pattern, ''hierarchicalcodelist'' is also a collection, i.e. a collection of hierarchies. | Although it is not following the ''item scheme'' pattern, ''hierarchicalcodelist'' is also a collection, i.e. a collection of hierarchies. | ||
Revision as of 13:53, 20 January 2021
Contents
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 |
|
| 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: |
Parameters
The following parameters are used for identifying resources:
| Parameter | Type | Description |
|---|---|---|
| agencyID | A string compliant with the SDMX common:NCNameIDType | The agency maintaining the artefact to be returned. It is possible to set more than one agency, using + as separator (e.g. BIS+ECB).
|
| resourceID | A string compliant with the SDMX common:IDType | The id of the artefact to be returned. It is possible to set more than one id, using + as separator (e.g. CL_FREQ+CL_CONF_STATUS).
|
| version | A string compliant with the SDMX common:VersionType | The version of the artefact to be returned. It is possible to set more than one version, using + as separator (e.g. 1.0+2.1).
|
The parameters mentioned above are specified using the following syntax:
protocol://domain/ws/public/sdmxapi/rest/resource/agencyID/resourceID/version
Additional parameter used for identifying a resource, for item scheme types
SDMX uses the item scheme pattern to model SDMX collections of items. These are principally:
- categoryscheme
- conceptscheme
- codelist
... and others concerning organisation schemes and VTL transformations.
A complete list can be found in the REST API Overview.
Although it is not following the item scheme pattern, hierarchicalcodelist is also a collection, i.e. a collection of hierarchies.
For these collections (those following the item scheme pattern or the hierarchicalcodelist), it is possible to use a 4th parameter for identifying a resource. The rules for the 3 other parameters, as defined in the section above, remain valid.
| Parameter | Type | Description |
|---|---|---|
| itemID | A string compliant with the SDMX common:NestedNCNameIDType for conceptscheme and agencyscheme, SDMX common:IDType for hierarchicalcodelist or with the SDMX common:NestedIDType in all other cases | The id of the item to be returned. It is possible to set more than one id, using + as separator (e.g. A+Q+M).
|
This 4th parameter is used as follows:
protocol://domain/ws/public/sdmxapi/rest/resource/agencyID/resourceID/version/itemID
