Configuring Dynamic Path Variables

This feature allows you to configure the path parameters in the API request. The path parameters are part of the end-point URL and point to a specific resource. They are enclosed by curly braces {}. For instance: – If you want to find a specific resource based on its ID, you can use the path parameter.

The path parameters are mandatory in the API request. When a client application calls an API, the actual values replace path parameters. The path parameter is added to the URL string after a forward slash character (/). The path parameter is delimited by the semicolon character (;).

To configure the path parameter:

  1. In the URL Details area, click the Is the URL have dynamic path variables check box, and the End Point Path Param Details tab comes into view.
  1. Click the End Point Path Param Details tab, and the Path Param 1 area opens.
  1. In the Path Param 1 area, enter the details of the path parameters as follows:
NameIn this field, enter a name of the parameter that you have defined in the code of the API or in the end-point URL.
Source of ValueClick this list and then select the source type (for example: – REQUEST_BODY) from where the value of the path parameter is fetched.  

To know more about all types of the sources, see the section: Selecting Source of Value.
ValueIn this field, you enter the parameter, or a constant value, or an in-built value based on the value that you select in the Source of Value list. This parameter is mapped to the value or absolute JSON path of the related element (for example: – text box) when you configure the API on an element (for example: – button).  

To define a parameter or an alphanumeric value: see the section: Selecting Source of Value.
MandatoryIf you click this check box, the Mandatory Message box opens. In the Mandatory Message box, enter an error message that the application will display if the mandatory parameter does not store a value.
Was this article helpful?