Difference between revisions of "Submit Structures Web Service"
Jump to navigation
Jump to search
(Created page with "Category:WebService = Overview = Fusion Registry provides a web service for the import of structural metadata. This can be in any supported structure format, with the in...") |
(→Overview) |
||
| Line 5: | Line 5: | ||
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 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" | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/sdmxapi/rest/ </b> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Secure</b></span> Agency and Admin only | ||
| + | |- | ||
| + | |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>Compression</b> || Zip files supported, if loading from URL gzip responses supported | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Content-Type</b>|| <p>1. multipart/form-data (if attaching file) – the attached file must be in field name of uploadFile</p> | ||
| + | <p>2. application/text or application/xml (if submitting data in the body of the POST)</p> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Response Format</b>|| SDMX-ML Submit Structure Response Message (XML) | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Response Statuses</b>|| <p><b>200</b> - Submission Success</p> | ||
| + | <p><b>400</b> - Submission could not be performed (either an unreadable dataset, or unresolvable reference to a required structure)</p> | ||
| + | <p><b>401</b> - Unauthorized (if access has been restricted)</p> | ||
| + | <p><b>500</b> - Server Error</p> | ||
| + | |} | ||
Revision as of 03:52, 7 May 2020
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 |
| 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 |
