Difference between revisions of "Explain Plan Web Services"

From Fusion Registry Wiki
Jump to navigation Jump to search
('Explain Plan' Web Service)
(Overview)
Line 1: Line 1:
 
[[Category:WebService]]
 
[[Category:WebService]]
 
= Overview =
 
= 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
 
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
  

Revision as of 00:27, 8 August 2023

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

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

The Web Services

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 goes into detail abot a Series Key.

'Explain Map' Web Service

For the supplied file and the URN of the mapping structure, returns a JSON obejct stating which series were mapped and which were unmapped from the input.

Entry Point ws/secure/structuremap/explainmap
Access Secure
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 JSON object
Response Statuses

200 - Query Ok

401 - Unauthorized (if access has been restricted)

'Explain Plan' Web Service

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

  • Takes the parameters "dsd", "map", "key"


Entry Point ws/secure/structuremap/explainplan
Access Secure
Authentication HTTP Basic Authentication
Http Method GET
Response Format JSON object
Response Statuses

200 - Success

401 - Unauthorized