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 a Domain Namespace's Overview page.

Create parameters

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

They are defined by using the following master data:

  • 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 (required)

  • 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 (required)

  • Location: This flag shows whether the parameter is located in the path, the query or the header of a request ( required)

  • 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 (required)

  • Description: This is used to give a longer description of the error that occurred (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).
Attention: The following header parameters should not be modelled 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 and X-DEBUG-SESSION. If Location is path, dots or dashes are not allowed in name. If a name was created by an uploading API containing dashes or dots, you will see a warning in the Problems section.

Edit parameters

You can edit the master data of a parameter by clicking the Edit parameter details button in the Parameter Details section on the parameter's instance page. Alternatively, you can use the Edit capability of each table row on the Parameters tab of a api namespace's Overview page. 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 clicking the Delete parameter button in the upper right corner of the parameter instance page. Alternatively, you can use the Delete capability of each table row on the Parameters tab of a api namespace's Overview page.

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.