Difference between revisions of "Explain Plan Web Services"
Jump to navigation
Jump to search
(Created page with "= 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...") |
(→'Explain Map' Web Service) |
||
| Line 11: | Line 11: | ||
* Returns the mapped and unmapped keys | * Returns the mapped and unmapped keys | ||
| − | Entry Point: < | + | {| class="wikitable" |
| − | + | |- | |
| + | |style="background-color:#eaecf0"|<b>Entry Point</b> || style="min-width:500px;" | <b> >ws/secure/structuremap/explainmap</b> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Access</b> || Secure </span> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Http Method</b> || POST | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Response Format</b> || application/json (array of objects) | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Response Statuses</b> || <p><b>200</b> - Query Ok<p> | ||
| + | |} | ||
=== 'Explain Plan' Web Service === | === 'Explain Plan' Web Service === | ||
Revision as of 00:41, 8 August 2023
Contents
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
