Difference between revisions of "Delete Structures Web Service"
(→HTTP Verbs) |
(→Overview) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:FMR REST API Reference]] | [[Category:FMR REST API Reference]] | ||
| − | |||
= Overview = | = Overview = | ||
| − | Fusion Registry provides a web service for '''deleting''' structural metadata. | + | Fusion Metadata 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 <code>DELETE</code> 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. | Deletion is performed by submitting a structure message as if importing the content to the Registry, but instead using the HTTP <code>DELETE</code> 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. | ||
| 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 |
|- | |- | ||
|style="background-color:#eaecf0"|<b>Http Method</b>|| POST | |style="background-color:#eaecf0"|<b>Http Method</b>|| POST | ||
|- | |- | ||
| − | |style="background-color:#eaecf0"|<b>Accepts</b>|| | + | |style="background-color:#eaecf0"|<b>Accepts</b>|| SDMX-ML,SDMX-JSON or SDMX-EDI structure messages |
|- | |- | ||
|style="background-color:#eaecf0"|<b>Compression</b> || Zip files supported, if loading from URL gzip responses supported | |style="background-color:#eaecf0"|<b>Compression</b> || Zip files supported, if loading from URL gzip responses supported | ||
| Line 31: | Line 30: | ||
|} | |} | ||
| + | =HTTP Verbs= | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | !|HTTP Verb|| Purpose | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>DELETE</b>|| Deletes the structures specified | ||
| + | |} | ||
| − | = HTTP | + | =HTTP Headers= |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | !|HTTP | + | !|HTTP Header || Purpose || Allowed Values |
|- | |- | ||
| − | |style="background-color:#eaecf0"|<b> | + | |style="background-color:#eaecf0"|<b>Accept</b>|| To define the response format || |
| + | application/vnd.sdmx.structure+xml;version=1.0<br> | ||
| + | application/vnd.sdmx.structure+xml;version=2.0<br> | ||
| + | application/vnd.sdmx.structure+xml;version=2.1 | ||
| + | |||
|} | |} | ||
Latest revision as of 23:54, 4 July 2022
Overview
Fusion Metadata 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 |
| Authentication | HTTP Basic Authentication |
| Http Method | POST |
| Accepts | SDMX-ML,SDMX-JSON or SDMX-EDI structure messages |
| 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 Headers
| HTTP Header | Purpose | Allowed Values |
|---|---|---|
| Accept | To define the response format |
application/vnd.sdmx.structure+xml;version=1.0 |
