Submit Structures Web Service

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)