Explain Plan Web Services

From Fusion Registry Wiki
Revision as of 23:41, 7 August 2023 by Plazarou (talk | contribs) ('Explain Map' Web Service)
Jump to navigation Jump to search

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
Http Method POST
Response Format application/json (array of objects)
Response Statuses

200 - Query Ok

'Explain Plan' Web Service

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

Entry Point: <registry>ws/secure/structuremap/explainplan