Submit Structures Web Service

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 Verbs

HTTP Verb	Purpose
APPEND	Adds the submitted structures to the Registry. An error is returned if any of the structures already exist.
REPLACE	Adds the submitted structures to the Registry. Structures that already exist are replaced.
FULLREPLACE	Deletes all structures in the Registry and replaces with the structures submitted.
MERGE	Adds submitted structures to the Registry. Structures with items like Codelists are merged.

HTTP Headers

HTTP Header	Purpose	Allowed Values
Accept	To define the response format	application/vnd.sdmx.structure+xml;version=1.0 application/vnd.sdmx.structure+xml;version=2.0 application/vnd.sdmx.structure+xml;version=2.1