Vmurrell at 10:09, 2 October 2025

2025-10-02T10:09:42Z

Plazarou: /* Overview */

2023-10-11T14:22:43Z

‎Overview

Plazarou: Created page with "Category:WebService Category:How_To = Overview = '''Note:''' this is the explanation for the Web Services in Fusion Registry Version 10. The Registry has the User Int..."

2023-10-11T14:22:29Z

Created page with "Category:WebService Category:How_To = Overview = '''Note:''' this is the explanation for the Web Services in Fusion Registry Version 10. The Registry has the User Int..."

New page

[[Category:WebService]]
[[Category:How_To]]
= Overview =
'''Note:''' this is the explanation for the Web Services in Fusion Registry Version 10.

The Registry has the User Interface feature "Test Mapping" which can be used to test an input file against a Mapping. This feature is very useful when debugging why a mapping did not occur. This page details how to directly call the Web Services that perform the explanation of a mapping

There are 2 Web Services. The firsts "explains" what series dimensions of an input file would be mapped and which would be unmapped with regards to a specifc Map, the second analyses a particular Series Key.

== 'Explain Map' Web Service ==

From the supplied file and the specified mapping structure URN, returns a JSON object stating which series were mapped and which were unmapped from the input.

{| class="wikitable"
|-
|style="background-color:#eaecf0"|Entry Point || style="min-width:500px;" | ws/secure/structuremap/explainmap
|-
|style="background-color:#eaecf0"|Access || Secure
|-
|style="background-color:#eaecf0"|Authentication || HTTP Basic Authentication
|-
|style="background-color:#eaecf0"|Http Method || POST
|-
|style="background-color:#eaecf0"|Accepts || SDMX-ML, SDMX-JSON or SDMX-EDI structure message
|-
|style="background-color:#eaecf0"|Content-Type || application/text or application/xml
|-
|style="background-color:#eaecf0"|Response Format || JSON object
|-
|style="background-color:#eaecf0"|Response Statuses || 200 - Query Ok
400 - Missing Header 'URN' or Unrecognised file input
401 - Unauthorized
404 - Cannot resolve reference to Structure Map specified in URN parameter
|}

=== HTTP Headers ===
The following header parameters must be specified:

{| class="wikitable"
|-
!|HTTP Header || Purpose || Allowed Values
|-
|style="background-color:#eaecf0"|URN || (Mandatory) States the mapping structure to map the input data against. || A valid URN for a Mapping. E.g. urn:sdmx:org.sdmx.infomodel.mapping.StructureMap=MAPPING_TEST:SS_DF(1.0).DF_MAP_TEST
|}

=== Output ===
The output JSON object has 4 fields:
* source - the URN of the DSD or Dataflow that was used as the source of the mapping
* target - the URN of the DSD or Dataflow that was used as the target of the mapping
* mapped - a JSON object. Each field is a unique input key that mapped. For each field is a String stating what it mapped to.
* unmapped - a JSON Array of Strings showing which keys from the input were unmapped

=== Example Output ===

<pre>
{
"source": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=MAPPING_TEST:DF_DSD1(1.0)",
"target": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=MAPPING_TEST:DF_DSD2(1.0)",
"mapped": {
"A:B:BEL": "AAAB:BEL:FIXED_EER",
"A:C:BEL": "AAAC:BEL:FIXED_EER",
"XXX:C:BAR": "AACC:BAR:FIXED_EER"
},
"unmapped": [
"C55BCX:C:BEL"
]
}
</pre>

=== HTTP Headers ===
The following header parameters must be specified:

{| class="wikitable"
|-
!|HTTP Header || Purpose || Allowed Values
|-
|style="background-color:#eaecf0"|URN || (Mandatory) States the mapping structure to map the input data against. || A valid URN for a Mapping. E.g. urn:sdmx:org.sdmx.infomodel.mapping.StructureMap=MAPPING_TEST:SS_DF(1.0).DF_MAP_TEST
|}

=== Output ===
The output JSON object has 4 fields:
* source - the URN of the DSD or Dataflow that was used as the source of the mapping
* target - the URN of the DSD or Dataflow that was used as the target of the mapping
* mapped - a JSON object. Each field is a unique input key that mapped. For each field is a String stating what it mapped to.
* unmapped - a JSON Array of Strings showing which keys from the input were unmapped

=== Example Output ===

<pre>
{
"source": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=MAPPING_TEST:DF_DSD1(1.0)",
"target": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=MAPPING_TEST:DF_DSD2(1.0)",
"mapped": {
"A:B:BEL": "AAAB:BEL:FIXED_EER",
"A:C:BEL": "AAAC:BEL:FIXED_EER",
"XXX:C:BAR": "AACC:BAR:FIXED_EER"
},
"unmapped": [
"C55BCX:C:BEL"
]
}
</pre>

== 'Explain Plan Series' Web Service ==
'''Available from Version 11.9.6 onwards''' - ''the output is the same as the now deprecated 'Explain Plan' Web Service''

Given the specified Key and Map, returns a JSON object stating the input, mappings and output for that series key

{| class="wikitable"
|-
|style="background-color:#eaecf0"|Entry Point || style="min-width:500px;" | ws/secure/structuremap/explainmapseries
|-
|style="background-color:#eaecf0"|Access || Secure
|-
|style="background-color:#eaecf0"|Authentication || HTTP Basic Authentication
|-
|style="background-color:#eaecf0"|Http Method || POST
|-
|style="background-color:#eaecf0"|Accepts || JSON message
|-
|style="background-color:#eaecf0"|Content-Type || application/json
|-
|style="background-color:#eaecf0"|Response Format || JSON object
|-
|style="background-color:#eaecf0"|Response Statuses || 200 - Query Ok
400 - Missing required field in JSON input
401 - Unauthorized
404 - Cannot resolve reference to Structure Map specified in URN parameter
|}

=== Example Input ===
<pre>
{
"StructureMap": "urn:sdmx:org.sdmx.infomodel.structuremapping.StructureMap=MAPPING_TEST:DF_MAP(1.0)",
"Series": "A B.C.BAR.2003",
"MapFrom": "source",
"ComponentValues": {
"OBS_STATUS": "5D",
"OBS_VALUE": "9993"
}
}
</pre>

=== Output ===
The output JSON object has the fields:
* reverseMapping - whether this was a reversed mapping or not
* input a JSON object stating the dimensions and attributes input. The dimensions will be the same as that passed in as the input parameter "key", but whereas the key only specified the value, this field shows the ID and value relationship.
* unmapped - a list of any Dimensions that are unmapped
* mappings - states the input mappings that were mapped as well as any fixed values output
* output - a JSON object with a field of "dimensions". This field lists the IDs of the output DSD or Dataflow and states what the values would be. If a dimension has a value of "null" it is unmapped. If it has a single value it was successfully mapped. If it has multiple values there this is also a failure as it is ambiguous as to what should be output.

=== Example Output ===

<pre>
{
"reverseMapping": false,
"input": {
"dimensions": {
"FREQ": "C55BCX",
"BIS_TOPIC": "C",
"REF_AREA": "BEL"
},
"attributes": {
"OBS_STATUS": null,
"OBS_PRE_BREAK": null,
"OBS_CONF": null,
"BREAKS": null,
"COVERAGE": null
}
},
"unmapped": [],
"mappings": {
"REF_AREA:BEL": {
"REF_AREA": [
"BEL"
]
},
"OBS_VALUE:*": {
"EER_TYPE": [
"FIXED_EER"
],
"COVERAGE": [
"FIXED_CVRG"
]
}
},
"output": {
"dimensions": {
"INSTRUMENT_TYPE": [
null
],
"REF_AREA": [
"BEL"
],
"EER_TYPE": [
"FIXED_EER"
]
}
}
}
</pre>

== 'Explain Plan' Web Service ==
'''Deprecated in Fusion Registry version 11.9.6: Use 'Explain Plan Series Key' Web Service instead''' - ''The new POST service generates the same output as this Web Service''

Given the specified Key and Map, returns a JSON object stating the input, mappings and output for that series key

{| class="wikitable"
|-
|style="background-color:#eaecf0"|Entry Point || ws/secure/structuremap/explainplan 
|-
|style="background-color:#eaecf0"|Access || Secure
|-
|style="background-color:#eaecf0"|Authentication || HTTP Basic Authentication
|-
|style="background-color:#eaecf0"|Http Method || GET
|-
|style="background-color:#eaecf0"|Response Format || JSON object
|-
|style="background-color:#eaecf0"|Response Statuses || 200 - Success
400 - Missing or invalid parameter 
401 - Unauthorized 
404 - Cannot resolve reference to Structure Map specified in "map" parameter
|-
|}

=== HTTP Query Parameters ===

{| class="wikitable"
|-
!| Request Parameter || Required || Purpose
|-
|style="background-color:#eaecf0"|dsd|| Yes || The URN of the DSD or Dataflow to map against. Depending on whether the source or target DSD / Dataflow is provided, the mapping can be reversed.
|-
|style="background-color:#eaecf0"|map|| Yes || The URN of the Structure Map to use in the mapping
|-
|style="background-color:#eaecf0"|key|| Yes || This is the token that was passed back from the Fusion registry server on the publication request
|-
|}

'''Note:''' in versions prior to Fusion Registry 10.9.4, the "dsd" parameter must specify a DSD and not a Datflow URN.

=== Output ===
The output JSON object has the fields:
* reverseMapping - whether this was a reversed mapping or not
* input a JSON object stating the dimensions and attributes input. The dimensions will be the same as that passed in as the input parameter "key", but whereas the key only specified the value, this field shows the ID and value relationship.
* unmapped - a list of any Dimensions that are unmapped
* mappings - states the input mappings that were mapped as well as any fixed values output
* output - a JSON object with a field of "dimensions". This field lists the IDs of the output DSD or Dataflow and states what the values would be. If a dimension has a value of "null" it is unmapped. If it has a single value it was successfully mapped. If it has multiple values there this is also a failure as it is ambiguous as to what should be output.

=== Example Output ===

<pre>
{
"reverseMapping": false,
"input": {
"dimensions": {
"FREQ": "C55BCX",
"BIS_TOPIC": "C",
"REF_AREA": "BEL"
},
"attributes": {
"OBS_STATUS": null,
"OBS_PRE_BREAK": null,
"OBS_CONF": null,
"BREAKS": null,
"COVERAGE": null
}
},
"unmapped": [],
"mappings": {
"REF_AREA:BEL": {
"REF_AREA": [
"BEL"
]
},
"OBS_VALUE:*": {
"EER_TYPE": [
"FIXED_EER"
],
"COVERAGE": [
"FIXED_CVRG"
]
}
},
"output": {
"dimensions": {
"INSTRUMENT_TYPE": [
null
],
"REF_AREA": [
"BEL"
],
"EER_TYPE": [
"FIXED_EER"
]
}
}
}
</pre>

= Simple Example =
The file attached defines a number of Structural Metadata artefacts in the Agency "MAPPING_TEST" that can be loaded into a Registry. The structures files contain 2 Dataflows and 2 DSDs. 2 Concept Schemes, 2 Codelists and 1 Structure Map (with Representation Map) which maps the Dataflows. All structures are for the agency "MAPPING_TEST".
* [[:File:STRUCTURES EXPLAINPLAN.zip|Structures SDMX 3.0]] - a zipped file for FMR 11 as is in SDMX 3 format
* [[:File:EXPLAINPLAN-DATA.zip|Test Data]] - this data file should be unzipped before use, to give a small SDMX-ML data file. This file can be loaded against the Dataflows from the Structure file.

== Invoking the Explain Map ==
Once the above Structural Metadata is loaded into your Registry, invoking the "Explain Map" Web Service by performing a POST call (using Curl, Python or POSTMAN) to:
<pre>
<your registry>/ws/secure/structuremap/explainmap
</pre>

This also requires the Header parameter '''URN''' to be specified as '''urn:sdmx:org.sdmx.infomodel.mapping.StructureMap=MAPPING_TEST:SS_DF(1.0).DF_MAP_TEST'''
 
The body should be the test file (above).
 
The resultant output will show that 3 series are mapped and the series "C55BCX:C:BEL" is unmapped. Part of the output will show:
<pre>
"mapped": {
"A:B:BEL": "AAAB:BEL:FIXED_EER",
"A:C:BEL": "AAAC:BEL:FIXED_EER",
"XXX:C:BAR": "AACC:BAR:FIXED_EER"
},
"unmapped": [
"C55BCX:C:BEL"
]
</pre>

== Invoking the Explain Plan ==
Now that we know that "C55BCX:C:BEL" is unmapped, we want to call the "explain plan" Web Service, to understand more about the unmapped series "C55BCX:C:BEL". The query needs to specify the Structure Map and specifying the "dsd" to be the Dataflow Reference:
 
=== Version 10.9.4 and above Registries===
The Dataflow URN can be specified as the "dsd" parameter like so:
<pre>
<your registry>/ws/secure/structuremap/explainplan?dsd=urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=MAPPING_TEST:DF_DSD1(1.0)&map=urn:sdmx:org.sdmx.infomodel.mapping.StructureMap=MAPPING_TEST:SS_DF(1.0).DF_MAP_TEST&key=C55BCX:C:BEL
</pre>

=== Version 10.9.3 and below Registries===
If the query used the DSD that the Dataflow is referencing (in the "dsd" parameter) the same result is achieved. The call with the underlying DSD is:
<pre>
<your registry>/ws/secure/structuremap/explainplan?dsd=urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=MAPPING_TEST:DSD1(1.0)&map=urn:sdmx:org.sdmx.infomodel.mapping.StructureMap=MAPPING_TEST:SS_DF(1.0).DF_MAP_TEST&key=C55BCX:C:BEL
</pre>

@@ Line 1: / Line 1: @@
-[[Category:WebService]]
+[[Category:RetiredFunctionality]]
 = Overview =
 '''Note: this is the explanation for the Web Services in Fusion Registry Version 10'''.

@@ Line 2: / Line 2: @@
 [[Category:How_To]]
 = Overview =
-'''Note:''' this is the explanation for the Web Services in Fusion Registry Version 10.
+'''Note: this is the explanation for the Web Services in Fusion Registry Version 10'''.
 The Registry has the User Interface feature "Test Mapping" which can be used to test an input file against a Mapping.  This feature is very useful when debugging why a mapping did not occur.  This page details how to directly call the Web Services that perform the explanation of a mapping

Explain Plan Web Services V10 - Revision history

Vmurrell at 10:09, 2 October 2025

Plazarou: /* Overview */

Plazarou: Created page with "Category:WebService Category:How_To = Overview = '''Note:''' this is the explanation for the Web Services in Fusion Registry Version 10. The Registry has the User Int..."