Define Path Parameters

Path parameters are defined in the "Path Parameters" dialog step.

At least one path parameter

An API URL must contain at least one path parameter.

Static, meaningful path parameters are a good choice for the (first) path parameter.

Click the " " icon to define a new path parameter.

Path Parameter Types

The following path parameters (and parameter types) can generally be defined:

Static Path Parameters

Example

/api/app/1A2B3C4D5E/v1

Static path parameters are not mapped to a data field.

For example, you can version the Application API using a static path parameter by assigning it "v1" or a similar name.

  1. Click "Static."

  2. 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.

Variable Path Parameters

Example

/api/app/1A2B3C4D5E/{store-id}

  1. Variable path parameters with "direct" data field mapping

    For all actions except "Read Multiple Records," the "Path Parameter" dialog box includes a selection dialog that allows you to assign the path parameter to a data field.

    Click "Data Field" and then select the desired data field.

  2. Variable path parameters with data field mapping via the filter dialog

    For the "Read Multiple Data Sets" action, in the "Path Parameter" dialog step, you first need to assign a name to the parameter and select a data type.

    The path parameter is assigned to a data field in the "Filter and Sort" dialog step.

    You can find detailed information on this in the following sections:

General Information About Path Parameters