Using examples | Qlik Cloud Help
Skip to main content
Qlik Resources
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal
Loading SearchUnify's search If you need assistance with your product, please contact Qlik Support.
Qlik Customer Portal

Using examples

Add sample data in example fields throughout your API.

In API Designer, you can add example values for various elements of your API. Once you have defined an example, it is used when making API calls to your mock.

In the following example, a data type was created using an example.

Screenshot of the Character data type that was generated from a JSON example.

This data type is then used as a response body for an operation.

The Character data type is returned for the method called Get a Star Wars character by ID.

You can define examples in different parts of your API, and some might override the others when making calls to your mock. Here, the example from the data type is used, but you can also define an example for the operation's response.

A new example is defined for the response. Here the character is Leia Organa.

External examples are not supported.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here