Submit Structures Web Service

From FMR Knowledge Base
Revision as of 09:24, 17 March 2021 by Glenn (talk | contribs) (Overview)
Jump to navigation Jump to search


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 Structure Message, SDMX-EDI, SDMX-JSON 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 structurs.
  • APPEND
  • REPLACE
  • MERGE
  • FULLREPLACE
  • DELETE