Generate JSON schema & sample JSON payload

To generate a JSON file from an Aspect Model, proceed as follows:

  • Click the Generate menu.

    The menu offers two options for JSON generation:

    • Sample JSON Payload

    • JSON Schema

      Generate JSON
If you run into errors, please make sure that your Aspect Model is valid.
If the invalid element is not highlighted with a red border, click the Validate icon to get a hint.

Generate sample JSON Payload

After selecting Generate → Sample JSON Payload, an example payload will be generated for the current model, and it will be displayed in the following preview dialog:

Generate sample JSON payload

  • You can now:

    • Edit the source in the preview.

    • Use the Copy to Clipboard function and continue editing with another tool.

    • Download the file locally.

Generate JSON Schema

After selecting Generate → JSON Schema, a JSON schema will be generated for the current model, and it will be displayed in the following preview dialog:

Generate JSON schema

The description fields inside the schema are taken from the samm:description texts of the model in one language. The schema is generated in the language of the user interface if the model contains texts in it, otherwise in English or in the first language of the model. If the model contains several languages, the preview offers a Language selection to generate the schema again in another language.

  • You can now:

    • Switch the language of the descriptions (models with several languages only).

    • Edit the source in the preview.

    • Use the Copy to Clipboard function and continue editing with another tool.

    • Download the file locally.