Difference between revisions of "Delete Structures Web Service"

From FMR Knowledge Base
Jump to navigation Jump to search
(Overview)
m (Correct errors)
 
Line 13: Line 13:
 
|style="background-color:#eaecf0"|<b>Authentication</b>|| HTTP Basic Authentication
 
|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>|| DELETE
 
|-
 
|-
 
|style="background-color:#eaecf0"|<b>Accepts</b>|| SDMX-ML,SDMX-JSON or SDMX-EDI structure messages
 
|style="background-color:#eaecf0"|<b>Accepts</b>|| SDMX-ML,SDMX-JSON or SDMX-EDI structure messages
Line 24: Line 24:
 
|style="background-color:#eaecf0"|<b>Response Format</b>|| SDMX-ML Submit Structure Response Message (XML)
 
|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>
+
|style="background-color:#eaecf0"|<b>Response Statuses</b>|| <p><b>200</b> - Deletion 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>400</b> - Deletion unsuccessful </p>
 
<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 Verbs=
 
{| class="wikitable"
 
|-
 
!|HTTP Verb|| Purpose
 
|-
 
|style="background-color:#eaecf0"|<b>DELETE</b>|| Deletes the structures specified
 
|}
 
 
=HTTP Headers=
 
{| class="wikitable"
 
|-
 
!|HTTP Header || Purpose || Allowed Values
 
|-
 
|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 10:31, 3 April 2025

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 DELETE
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 - Deletion success

400 - Deletion unsuccessful

401 - Unauthorized (if access has been restricted)

500 - Server Error