Reference Metadata API - Revision history

Plazarou: /* Examples */

2024-02-12T15:45:16Z

‎Examples

Plazarou: /* Examples */

2023-04-13T15:07:30Z

‎Examples

Plazarou: /* DELETE Reference Metadata */

2023-04-13T15:07:00Z

‎DELETE Reference Metadata

Plazarou: /* POST Reference Metadata */

2023-04-13T15:05:06Z

‎POST Reference Metadata

Glenn at 16:12, 22 July 2022

2022-07-22T16:12:43Z

Glenn: Created page with "Category:Reference Metadata See Reference Metadata = Overview = This API supports GET (retrieve reference metadata), POST (submit new or modified r..."

2022-07-22T16:07:24Z

Created page with "Category:Reference Metadata See Reference Metadata = Overview = This API supports GET (retrieve reference metadata), POST (submit new or modified r..."

New page

[[Category:Reference Metadata]]
See [[Reference_Metadata|Reference Metadata]]

= Overview =
This API supports GET (retrieve reference metadata), POST (submit new or modified reports), and DELETE (remove existing reports) methods to maintain Reference Metadata Reports.

The GET methods conform to the [https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/metadata.md SDMX REST Specification for reference metadata retrieval].

== GET Reference Metadata ==
{| class="wikitable"
|-
|style="background-color:#eaecf0"|Entry Point|| /sdmx/v2/metadata
|-
|style="background-color:#eaecf0"|Access|| Public
|-
|style="background-color:#eaecf0"|Http Method|| GET
|-
|style="background-color:#eaecf0"|Response Format|| JSON
|-
|style="background-color:#eaecf0"|Response Statuses|| 200 - Success
401 - Unauthorized (if access has been restricted)
500 - Server Error
|}

[https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/metadata.md See Specification].

==Examples==
Get specific report
https://example.registry.com/sdmx/v2/metadata/metadataset/MT/REPORT1/1.0

Get all metadata sets for a specific Metadata Provider
https://example.registry.com/sdmx/v2/metadata/metadataset/MT.PROVIDER/*/*

Get all reports against Metadataflow as Stubs (only include basic details, not the actual reported content)
https://example.registry.com/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0?detail=allStubs

Get all reports against Metadataflow for a specific Metadata Provider
https://example.registry.com/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0/PROVIDER1

Get all reports against any BIS Codelist
https://example.registry.com/sdmx/v2/metadata/strucure/codelist/BIS

== POST Reference Metadata ==
{| class="wikitable"
|-
|style="background-color:#eaecf0"|Entry Point|| /sdmx/v2/metadata
|-
|style="background-color:#eaecf0"|Access|| Public
|-
|style="background-color:#eaecf0"|Http Method|| POST
|-
|style="background-color:#eaecf0"|Accepts|| [https://github.com/sdmx-twg/sdmx-json/tree/master/metadata-message SDMX-JSON]
|-
|style="background-color:#eaecf0"|Content-Type|| 1. multipart/form-data (if attaching file) – the attached file must be in field name of uploadFile
2. application/text or application/json (if submitting data in the body of the POST)
|-
|style="background-color:#eaecf0"|Response Format|| N/A
|-
|style="background-color:#eaecf0"|Response Statuses|| 200 - Success
401 - Unauthorized (if access has been restricted)
500 - Server Error
|}

Submit a Reference Metadata report, on success an HTTP 200 status is returned. On failure an SDMX Error message is returned with the HTTP status code set to the appropriate code.

Example Error:

<?xml version="1.0" ?>
<message:Error xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:message="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message" xmlns:com="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common">
<message:ErrorMessage code="100">
<com:Text>Could not resolve reference from structure Metadata Set 'MT:EXAMPLE1.0.0)' to structure Metadata Provision Agreement 'MT:MUK1_EXAMPLE(1.0)'</com:Text>
</message:ErrorMessage>
</message:Error>

== DELETE Reference Metadata ==
{| class="wikitable"
|-
|style="background-color:#eaecf0"|Entry Point|| /sdmx/v2/metadata
|-
|style="background-color:#eaecf0"|Access|| Public
|-
|style="background-color:#eaecf0"|Http Method|| DELETE
|-
|style="background-color:#eaecf0"|Response Format||
|-
|style="background-color:#eaecf0"|Response Statuses|| 200 - Success
401 - Unauthorized (if access has been restricted)
500 - Server Error
|}

Deletes all reference metadata reports which match the query URL, the path parameters following the /metadata/ are used to create a filter on the Metadata Reports. The path uses the same syntax as the
[https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/metadata.md GET parameters], it is therefore possible to delete by specific report identifiers, by metadataflow, or by structure query.

==Examples==
Delete specific report
https://example.registry.com/sdmx/v2/metadata/metadataset/MT/REPORT1/1.0

Delete all versions of report
https://example.registry.com/sdmx/v2/metadata/metadataset/MT/REPORT1/*

Delete all reports against Metadataflow
https://example.registry.com/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0

Delete all reports against Metadataflow for a specific Metadata Provider
https://example.registry.com/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0/PROVIDER1

Delete all reports against all BIS Codelists
https://example.registry.com/sdmx/v2/metadata/strucure/codelist/BIS

@@ Line 45: / Line 45: @@
 {| class="wikitable"
 |-
-|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /sdmx/v2/metadata</b>
+|style="background-color:#eaecf0"|<b>Entry Point (11.6.0 onwards)</b>|| <b> /ws/secure/sdmx/v2/metadata</b>
 |-
 |style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:green'><b>Public</b></span>

← Older revision		Revision as of 16:12, 22 July 2022
Line 1:		Line 1:
		+	[[Category:FMR_REST_API_Reference]]
	[[Category:Reference Metadata]]		[[Category:Reference Metadata]]
	See [[Reference_Metadata\|Reference Metadata]]		See [[Reference_Metadata\|Reference Metadata]]

@@ Line 40: / Line 40: @@
 Get all reports against any BIS Codelist
-  https://example.registry.com/sdmx/v2/metadata/strucure/codelist/BIS
+  https://example.registry.com/sdmx/v2/metadata/structure/codelist/BIS
 == POST Reference Metadata ==

@@ Line 99: / Line 99: @@
 ==Examples==
 Delete specific report
-  https://example.registry.com/sdmx/v2/metadata/metadataset/MT/REPORT1/1.0
+  https://example.registry.com/ws/secure/sdmx/v2/metadata/metadataset/MT/REPORT1/1.0
 Delete all versions of report
-  https://example.registry.com/sdmx/v2/metadata/metadataset/MT/REPORT1/*
+  https://example.registry.com/ws/secure/sdmx/v2/metadata/metadataset/MT/REPORT1/*
 Delete all reports against Metadataflow
-  https://example.registry.com/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0
+  https://example.registry.com/ws/secure/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0
 Delete all reports against Metadataflow for a specific Metadata Provider
-  https://example.registry.com/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0/PROVIDER1
+  https://example.registry.com/ws/secure/sdmx/v2/metadata/metadataflow/MT/MDF1/1.0/PROVIDER1
 Delete all reports against all BIS Codelists
-  https://example.registry.com/sdmx/v2/metadata/strucure/codelist/BIS
+  https://example.registry.com/ws/secure/sdmx/v2/metadata/strucure/codelist/BIS