Difference between revisions of "Submit Structures Web Service"

From FMR Knowledge Base
Jump to navigation Jump to search
(→‎HTTP Verbs)
(→‎HTTP Headers)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Category:FMR REST API Reference]]
 
[[Category:FMR REST API Reference]]
−
 
 
= Overview =  
 
= Overview =  
−
Fusion Registry provides a web service for the import of structural metadata. This can be in any supported structure format, with the information supplied as a file, zip file, in the HTTP body.   
+
Fusion Metadata Registry provides a web service for the import of structural metadata. This can be in any supported structure format, with the information supplied as a file, zip file, in the HTTP body.   
  
−
The Fusion Registry import actions can be used to tell the service how to treat the incoming information (Appned, Repace, Delete, Full Replace, Merge).
+
The Registry import actions can be used to tell the service how to treat the incoming information (Append, Replace, Delete, Full Replace, Merge).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 12: Line 11:
 
|style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Secure</b></span> Agency and Admin only
 
|style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Secure</b></span> Agency and Admin only
 
|-
 
|-
−
|style="background-color:#eaecf0"|<b>Autnentication</b>|| HTTP Basic Authentication, Certificate Autentication
+
|style="background-color:#eaecf0"|<b>Authentication</b>|| HTTP Basic Authentication
 
|-
 
|-
 
|style="background-color:#eaecf0"|<b>Http Method</b>|| POST
 
|style="background-color:#eaecf0"|<b>Http Method</b>|| POST
 
|-
 
|-
−
|style="background-color:#eaecf0"|<b>Accepts</b>|| XLSX, SDMX-ML, SDMX-EDI (any format for which there is a Structure Reader)
+
|style="background-color:#eaecf0"|<b>Accepts</b>|| SDMX-ML, SDMX-JSON or SDMX-EDI structure message
 
|-
 
|-
 
|style="background-color:#eaecf0"|<b>Compression</b> || Zip files supported, if loading from URL gzip responses supported
 
|style="background-color:#eaecf0"|<b>Compression</b> || Zip files supported, if loading from URL gzip responses supported
Line 31: Line 30:
 
|}
 
|}
  
−
 
+
= HTTP Headers =
−
=HTTP Verbs=
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
!|HTTP Verb|| Purpose
+
!|HTTP Header || Purpose || Allowed Values
 
|-
 
|-
−
|style="background-color:#eaecf0"|<b>APPEND</b>|| Adds the submitted structures to the Registry. An error is returned if any of the structures already exist.
+
|style="background-color:#eaecf0"|<b>ACTION</b>|| If not present in the structure message, the action is used to inform the server how to process the structures. ||
 +
<ul>
 +
<li>APPEND</li>
 +
<li>REPLACE</li>
 +
<li>MERGE</li>
 +
<li>FULLREPLACE</li>
 +
<li>DELETE</li>
 +
</ul>
 
|-
 
|-
−
|style="background-color:#eaecf0"|<b>REPLACE</b>|| Adds the submitted structures to the Registry. Structures that already exist are replaced.
+
|style="background-color:#eaecf0"|<b>Skip-Invalid</b>|| If set to true, if an attempt is made to load invalid structures (such as structures that have invalid cross-references) this will not prevent the loading of any submitted valid structures (since FMR 11.18.2) || boolean (default is false)
−
|-
+
 
−
|style="background-color:#eaecf0"|<b>FULLREPLACE</b>|| Deletes all structures in the Registry and replaces with the structures submitted.
 
−
|-
 
−
|style="background-color:#eaecf0"|<b>MERGE</b>|| Adds submitted structures to the Registry. Structures with items like Codelists are merged.
 
 
|}
 
|}
  
−
=HTTP Headers=
+
=Parameters=
 +
The following parameters may also be specified:
 +
 
 
{| class="wikitable"
 
{| class="wikitable"
 +
! Parameter !! Type !! Description
 
|-
 
|-
−
!|HTTP Header || Purpose || Allowed Values
+
| skipInvalid
 +
| boolean (default is false)
 +
| If set to true, if an attempt is made to load invalid structures (such as structures that have invalid cross-references) this will not prevent the loading of any submitted valid structures (since FMR 11.18.2)
 
|-
 
|-
−
|style="background-color:#eaecf0"|<b>Accept</b>|| To define the response format ||
 
−
application/vnd.sdmx.structure+xml;version=1.0<br>
 
−
application/vnd.sdmx.structure+xml;version=2.0<br>
 
−
application/vnd.sdmx.structure+xml;version=2.1
 
−
 
 
|}
 
|}

Latest revision as of 07:12, 24 October 2024

Overview

Fusion Metadata Registry provides a web service for the import of structural metadata. This can be in any supported structure format, with the information supplied as a file, zip file, in the HTTP body.

The Registry import actions can be used to tell the service how to treat the incoming information (Append, Replace, Delete, Full Replace, Merge).

Entry Point /ws/secure/sdmxapi/rest/
Access Secure Agency and Admin only
Authentication HTTP Basic Authentication
Http Method POST
Accepts SDMX-ML, SDMX-JSON or SDMX-EDI structure message
Compression Zip files supported, if loading from URL gzip responses supported
Content-Type

1. multipart/form-data (if attaching file) – the attached file must be in field name of uploadFile

2. application/text or application/xml (if submitting data in the body of the POST)

Response Format SDMX-ML Submit Structure Response Message (XML)
Response Statuses

200 - Submission Success

400 - Submission could not be performed (either an unreadable dataset, or unresolvable reference to a required structure)

401 - Unauthorized (if access has been restricted)

500 - Server Error

HTTP Headers

HTTP Header Purpose Allowed Values
ACTION If not present in the structure message, the action is used to inform the server how to process the structures.
  • APPEND
  • REPLACE
  • MERGE
  • FULLREPLACE
  • DELETE
Skip-Invalid If set to true, if an attempt is made to load invalid structures (such as structures that have invalid cross-references) this will not prevent the loading of any submitted valid structures (since FMR 11.18.2) boolean (default is false)

Parameters

The following parameters may also be specified:

Parameter Type Description
skipInvalid boolean (default is false) If set to true, if an attempt is made to load invalid structures (such as structures that have invalid cross-references) this will not prevent the loading of any submitted valid structures (since FMR 11.18.2)
Retrieved from "https://fmrwiki.sdmxcloud.org/index.php?title=Submit_Structures_Web_Service&oldid=7763"