Explain Plan Web Services

Overview

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

Note: This UI feature and the Web Services require authentication into the Registry

The Web Services

There are 2 Web Services. The firsts "explains" why the

'Explain Map' Web Service

• An HTTP POST request
• Takes the parameters "URN" and the input file
• Returns the mapped and unmapped keys

Entry Point	ws/secure/structuremap/explainmap
Access	Secure Agency and Admin only
Authentication	HTTP Basic Authentication
Http Method	POST
Accepts	SDMX-ML, SDMX-JSON or SDMX-EDI structure message
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	application/json (array of objects)
Response Statuses	200 - Query Ok 401 - Unauthorized (if access has been restricted)

'Explain Plan' Web Service

• An HTTP GET request
• Takes the parameters "dsd", "map", "key"
• Returns the input, mappings and output

Entry Point	ws/secure/structuremap/explainplan
Access	Public
Authentication	Secure
Http Method	GET
Response Format	JSON
Response Statuses	200 - Success 401 - Unauthorized