Difference between revisions of "Query Structures Web Service"

From FMR Knowledge Base
Jump to navigation Jump to search
(Overview)
(Overview)
Line 1: Line 1:
 
[[Category:FMR REST API Reference]]
 
[[Category:FMR REST API Reference]]
 
= Overview =  
 
= Overview =  
Fusion Registry provides a web service for '''deleting''' structural metadata.  
+
Fusion Metadata Registry provides a web service for '''querying''' structural metadata.  
  
Deletion is performed by submitting a structure message as if importing the content to the Registry, but instead using the HTTP <code>DELETE</code> verb. The structure message can be in any supported structure format, with the information supplied as a file, zip file, or in the HTTP body.
+
The Structure REST API conforms to the [[REST_API_Overview#Structural_Metadata_Queries|SDMX specification]].
 +
 
 +
In addition to the SDMX specification, the Fusion Registry supports some additional Accept header values and
 +
query parameters.
 +
 
 +
Both the SDMX and extended query parameters are included in this guide.
 +
 
  
 
{| class="wikitable"
 
{| class="wikitable"

Revision as of 12:09, 20 January 2021

Overview

Fusion Metadata Registry provides a web service for querying structural metadata.

The Structure REST API conforms to the SDMX specification.

In addition to the SDMX specification, the Fusion Registry supports some additional Accept header values and query parameters.

Both the SDMX and extended query parameters are included 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