Message Tree-view context menu
Add occurrence
Only enabled on a repeating element.
Will add an occurrence of the repating element.
Delete
Only enabled on repeating elements except for first occurrences.
Will delete an occurrence of the repating element.
Change datatype to...
Only enabled on complex datatypes (XSD) with no child elements.
With this menu-item you can specify a datatype to apply for the element.
Copy to clipboard
Will copy the downline of the focused element in XML format.
Copy as (XML | JSON | YAML)
Will copy the downline of the focused element in the selected format.
Copy (Name | Full name)
Will copy either the name or the fullname of the focused element to the clipboard.
Paste from clipboard
Will overwrite the downline of the selected element with data from the clipboard. Names of the root element may differ.
Downwards only corresponding data will be copied. Elements in the downline for which no data is supplied will get lost.
If apiUi can not interpret the content of the clipboard, an exception is raised.
Runtime copy element
Use this option for processing inbound messages (mocking).
A pop-up screen will be shown to select a request element. On runtime, apiUi will use that request element to use it in the response.
In your design-screen you can recognise application of this feature because the value will start with :=
Runtime expression
Use this option for processing inbound messages (mocking).
A screen will pop-up in which you can specify the right-side of an assignment statement (only the right side because the focused element is the left side).
On runtime, apiUi will use that request element to use it in the response.
In your design-screen you can recognise application of this feature because the value will start with :=
Include element in case...
Only enabled on group elements.
A screen will pop-up in which you can specify a condition.
On runtime, apiUi will evaluate this condition and will only include the focused element in case the condition is met.
In your design-screen you can recognise application of this feature because the value will start with =
Populate (All | Required)
In a hurry and want to have data in the downline of an element?
Choose All
to populate the entrire downline, Required
if you only want to populate mandatory elements.
Note: Although populated data is according datatypes (string, integer, date...), it may violate schema rules.
Note: When a group is a list of options (xml: choice, json: oneOf),
all options are filled but only the last option is chosen (`checked`).
Validate
Will, on designtime, validate (the downline of ) an element against it's schema and show a report.
Expand
Will expand a group element one level.
Full collapse
Will fully collapse a group`.
Full expand
Will fully expand a group`.
Column width...
Applies to the column you clicked in to enter the context menu.
Shows a pop-up screen to change the column width.
Zoom value as Text
Use this option to show the full text in case the value-column is to small to show the entire value.
Zoom value as XML
Use this option to show the full value in case it is embeded xml.
Generate >
A few text generators that may ease your work.
Script Assignments
Generates a script that when executed will populate this element and its downline as it is now.
Note: Since the context of the scripts is not known to the generator, the generated script will require some post-editing.
Schema report in Clipboard(SpreadSheet)
Fills your clipboard with schema information that can be pasted in Excel (where you may need to set format to Text) so you can post-process it to create documentation.
YAML schema
Generates a YAML schema for the current element, regardless of the language the schema is written in.
Help
Shows this page from apiUi. Might be the way you got here...