Difference between revisions of "Delete Structures Web Service"
(→HTTP Verbs) |
|||
| Line 30: | Line 30: | ||
<p><b>500</b> - Server Error</p> | <p><b>500</b> - Server Error</p> | ||
|} | |} | ||
| − | |||
= HTTP Verbs = | = HTTP Verbs = | ||
| Line 38: | Line 37: | ||
|- | |- | ||
|style="background-color:#eaecf0"|<b>DELETE</b>|| Deletes the structures specified | |style="background-color:#eaecf0"|<b>DELETE</b>|| Deletes the structures specified | ||
| + | |} | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | !|HTTP Header || Purpose || Allowed Values | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Data-Format</b>|| Used to inform the server when the data is in CSV format. ||csv;delimiter=[delimiter] | ||
| + | <p>Where [delimiter] is either:</p> | ||
| + | <ul> | ||
| + | <li>comma</li> | ||
| + | <li>tab</li> | ||
| + | <li>semicolon</li> | ||
| + | <li>space</li> | ||
| + | </ul> | ||
|} | |} | ||
Revision as of 04:32, 24 September 2020
Overview
Fusion Registry provides a web service for deleting structural metadata.
Deletion is performed by submitting a structure message as if importing the content to the Registry, but instead using the HTTP DELETE verb. The structure message can be in any supported structure format, with the information supplied as a file, zip file, or in the HTTP body.
| 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 |
|---|---|
| DELETE | Deletes the structures specified |
| HTTP Header | Purpose | Allowed Values |
|---|---|---|
| Data-Format | Used to inform the server when the data is in CSV format. | csv;delimiter=[delimiter]
Where [delimiter] is either:
|
