API Parameters

Parameters are defined either as header, query or path parameters. You can create a new parameter by using the Create capability in the Parameters tab of the domain namespace's Overview page.

Create Parameters

A parameter can be created by using the "Create" capability.

They 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 allowed for naming parameters! Furthermore, names may not begin with a digit and the first character must be lowercase. The identifier cannot be changed after creation. This field is mandatory.
Name	This is the name of the parameter. The name of a path parameter must be identical to the parameter as defined in the path. This field is mandatory.
Location	This flag shows whether the parameter is located in the path, the query or the header of a request. This field is mandatory.
Parameter type	Either choose a primitive type to directly create an inline schema parameter or choose one from the list of the primitive schema types that have already been 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 occurred. This field is optional.

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

Note: The following header parameters should not be modeled to avoid duplicate issues because they are added automatically during the build pipeline's run:

'Accept-Language'
'X-B3-ParentSpanId'
'X-B3-SpanId'
'X-B3-TraceId'
'X-B3-Sampled'
'X-DEBUG-SESSION'

Edit Parameters

You can edit a parameter by using the Information capability, 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 Name, Location, Schema and Description.

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

Delete Parameters

You can delete a parameter by using the inline Delete capability. Alternatively, 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 permanently deleted.

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