Use the Web Services Page to build queries on Structures

From FMR Knowledge Base
Revision as of 03:42, 13 March 2021 by Vmurrell (talk | contribs)
Jump to navigation Jump to search

Overview

The Web Services page allows you to use the on-screen options to build a Query URL. The query URL can be used for a variety of purposes and more detail can be found in the Web Services User Guide. This article concentrates on using this page to retrieve and submit structures.

As selections are made from the options, you will notice that the URL will change. The URL can also be manipulated manually by adding other path parameters as detailed in the Web Services User Guide however some useful examples are shown later in this article.


Webservices.PNG

Options

Structure Type

Clicking the dropdown will display a list of all possible structures. The last option on the list is All Structures which should be used with caution depending on the size of the Registry.

Agency

Clicking the dropdown will display a list of all the Agencies in the Registry. The first option on the list is All Agencies which should be used with caution depending on the on the size of the Registry and the Structure Type selected above.

Version

The default is Latest but it is possible to choose All or to select a specific Version Number too.






Useful Parameters=

Multiple Versions

+ Operator URL
Use this to obtain a number of versions as shown in the example which is a request for the versions of a specific Codelist http://localhost:8085/FusionRegistry/ws/public/sdmxapi/rest/codelist/MY_AGENCY/all/1.0+1.1+1.2/?format=sdmx-2.1&detail=full&references=none