Difference between revisions of "Submit Structures Web Service"

From FMR Knowledge Base
Jump to navigation Jump to search
(→‎Overview)
Line 4: Line 4:
 
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 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 (Append, Replace, Delete, Full Replace, Merge).
+
The Fusion Registry import actions can be used to tell the service how to treat the incoming information (Appned, Repace, Delete, Full Replace, Merge).
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 31: Line 31:
 
|}
 
|}
  
−
=HTTP Verbs=
 
−
{| class="wikitable"
 
−
|-
 
−
!|HTTP Verb|| Purpose
 
−
|-
 
−
|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>REPLACE</b>|| Adds the submitted structures to the Registry. Structures that already exist are replaced.
 
−
|-
 
−
|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 the submitted structures to the Registry. Items like Codes and Concepts are merged where the structures already exist.
 
−
|}
 
  
−
=HTTP Headers=
+
= HTTP Headers =
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
!|HTTP Header || Purpose || Allowed Values
 
!|HTTP Header || Purpose || Allowed Values
 
|-
 
|-
−
|style="background-color:#eaecf0"|<b>Accept</b>|| To define the response format ||
+
|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 structurs. ||
−
application/vnd.sdmx.structure+xml;version=1.0<br>
+
<ul>
−
application/vnd.sdmx.structure+xml;version=2.0<br>
+
<li>APPEND</li>
−
application/vnd.sdmx.structure+xml;version=2.1
+
<li>REPLACE</li>
 +
<li>MERGE</li>
 +
<li>FULLREPLACE</li>
 +
<li>DELETE</li>
 +
</ul>
  
 
|}
 
|}

Revision as of 11:12, 20 January 2021


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.

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

Entry Point /ws/secure/sdmxapi/rest/
Access Secure Agency and Admin only
Autnentication HTTP Basic Authentication, Certificate Autentication
Http Method POST
Accepts XLSX, SDMX-ML, SDMX-EDI (any format for which there is a Structure Reader)
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 structurs.
  • APPEND
  • REPLACE
  • MERGE
  • FULLREPLACE
  • DELETE
Retrieved from "https://fmrwiki.sdmxcloud.org/index.php?title=Submit_Structures_Web_Service&oldid=3540"