Manage Parameters

Parameters are defined within a path as either query or path parameters. You can create a new parameter by using the Create capability in the parameters overview page.

Create a parameter

A parameter can be created in the parameters overview page by using the Create capability.

Parameters are defined by using the following master data:


Property	Description
Identifier	This is the identifier of the parameter. It is unique within a namespace. Please note that only the characters A-z (without special characters), digits and the special characters “-” and "_" are permitted for naming parameter! Furthermore, names may not begin with a digit and the first character must be lowercase. The identifier can not be changed after creation. This field is mandatory.
Name	This is the name of the parameter. For path parameters the name must be identical to the parameter as defined in the path. This field is mandatory.
Location	This is a flag representing whether the parameter is located in the path or in the query of a path. This field is mandatory.
Parameter type	Either choose a primitive type to directly create an inline schema parameter or choose out of the list of the primitive schema types that have already been created. The one chosen will be the type of the parameter that s being created. This field is mandatory.
Required	This is a Boolean. If it is checked then the property is required, otherwise it is optional.
Description	This is used to give a longer description of the error that occured. This field is optional.

Note: In case creating an parameter with an inline schema you have to specifiy additional information for that schema and in case of String, Number or Integer in addition the Enumeration elements (if needed).

Edit a parameter

You can edit a parameter by using the Information capability and navigating to the Master Data section and using the Edit master data capability. Alternatively, you can edit the parameter by using the inline Edit capability. The fields that can be edited are the name, the location, the schema and the description.

Note: In case editing an parameter with an inline schema you can access additional information for that schema and in case of String, Number or Integer in addition the Enumeration elements (if needed).

Delete a parameter

You can delete the parameter by using the inline Delete capability. Alternativerly, you can use the Information capability to access the details view and there you can use the Delete capability.

You will need to confirm the action before the selected parameter is permanetely deleted.

Attention: You can only delete a parameter if it is not in use.