Difference between revisions of "Structural Metadata Import Web Service"
Jump to navigation
Jump to search
(→Overview) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:WebService]] | [[Category:WebService]] | ||
| − | |||
= Overview = | = 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. | 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 ( | + | The Fusion Registry import actions can be used to tell the service how to treat the incoming information (Append, Replace, Delete, Full Replace, Merge). |
{| class="wikitable" | {| class="wikitable" | ||
| Line 12: | Line 11: | ||
|style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Secure</b></span> Agency and Admin only | |style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Secure</b></span> Agency and Admin only | ||
|- | |- | ||
| − | |style="background-color:#eaecf0"|<b> | + | |style="background-color:#eaecf0"|<b>Authentication</b>|| HTTP Basic Authentication, Certificate Authentication |
|- | |- | ||
|style="background-color:#eaecf0"|<b>Http Method</b>|| POST | |style="background-color:#eaecf0"|<b>Http Method</b>|| POST | ||
| Line 29: | Line 28: | ||
<p><b>401</b> - Unauthorized (if access has been restricted)</p> | <p><b>401</b> - Unauthorized (if access has been restricted)</p> | ||
<p><b>500</b> - Server Error</p> | <p><b>500</b> - Server Error</p> | ||
| + | |} | ||
| + | |||
| + | = HTTP Headers = | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | !|HTTP Header || Purpose || Allowed Values | ||
| + | |- | ||
| + | |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. || | ||
| + | <ul> | ||
| + | <li>APPEND</li> | ||
| + | <li>REPLACE</li> | ||
| + | <li>MERGE</li> | ||
| + | <li>FULLREPLACE</li> | ||
| + | <li>DELETE</li> | ||
| + | </ul> | ||
| + | |||
|} | |} | ||
Latest revision as of 23:20, 10 September 2023
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 (Append, Replace, Delete, Full Replace, Merge).
| Entry Point | /ws/secure/sdmxapi/rest/ |
| Access | Secure Agency and Admin only |
| Authentication | HTTP Basic Authentication, Certificate Authentication |
| 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. |
|
