Define Query Parameters
Query parameters are defined in the "Query Parameters" dialog step.
It is not always necessary to create a query parameter.
Click
to define a new query parameter.
Query Parameter Types
The types of query parameters you can create depend on which action or method you selected in the "Data Group Selection" dialog step.
Static Query Parameters
You can always create a static query parameter.
-
Click "Static."
-
Enter a name in the "Name" field.
The name must be at least two characters long and begin with a lowercase letter. In addition, it may only contain alphanumeric characters and underscores.
Query Parameters with Data Field Mapping
Click "Data Field" to create a query parameter with an (immediate) data field mapping.
Next, select the desired data field.
Name
Enter a name for the parameter here.
The name may appear only once in an endpoint.
The name must match the regular expression [a-zA-Z][a-zA-Z\\d-_.]+. That means it must be at least two characters long and start with a letter. Only letters, numbers, hyphens, underscores, and periods are allowed.
Data Type
Select the data type for the path parameter here.
The data type of the incoming path parameter must match the data type selected here. If the data types do not match, the corresponding request will not be processed.
Fallback
Here you can specify a fallback value for the parameter.
The fallback value is used when the parameter must be evaluated in any case, but a value for the parameter does not necessarily have to be provided when the endpoint is called.
This parameter is required
If you select the checkbox, the parameter must be specified in the request.
Checking this box can be helpful, among other things, when a parameter is definitely expected but a meaningful fallback cannot be defined (for example, a user ID).
Description
Enter a description for the parameter here. Multi-line text is allowed. The description is part of the Swagger documentation.


