Adding filter parameters

The Connector Development Kit provides you with the ability to create, add, edit, and remove query and header parameters.

You can create filter parameters in two places, that is, in the Request tab of an action or in the connector’s Schema tab. This topic describes how to add and create a parameter in the Request tab of an action. When you create a parameter within an action, it is known as a local parameter. Parameters can also be created in the Schema tab for a connector. Parameters that are created in the Schema tab are known as global parameters because any action can use them. Local parameters can be used only with the action they are created within. For more information about global parameters, see Global parameters.

To add a global parameter or create a local parameter, complete the following steps:

1. From the Connector Development Kit home page, click the connector that you want to work with.

2. Go to the Actions tab, and then select the action that you want to work with.

3. Go to the Request tab.

4. In the Filter parameters section, click Add or remove. The Add or remove parameters side panel is displayed.

5. If you want to use a global parameter, click Global parameters, and select the parameters that you want to use.

6. If you want to create a new parameter also known as a local parameter:

   1. Select Create a local parameter.

   2. Update the Display name, Property and optionally add a description.

      • Display name: The human-readable name that is displayed to users.
      • Property: The name of the parameter as defined in the connectors API. Ensure that you use the correct property otherwise, tests will fail (Normally this property is lowercase and concatenated if it contains more than one word).

   3. In the Type field, select one of the following options based on the property type:

      • String
      • Integer
      • Number
      • Boolean
      • Array of strings
      • Array of integers
      • Array of numbers
      • Date

   4. Select one of the following Field display type options:

      • Text input
      • Text area
      • Dropdown
      Note: If you select the field display type as Dropdown, then you can add additional stored values (property ID), display name, and define the order. For the Boolean data type, the stored value and display name are noneditable.
   5. If you selected the parameter type as String, Number, Integer, or Date and set the Location as Query, then select a list of Operators that can be used as a filter for your query parameter.

      Restriction: The operators that you specify for the query parameter may not work on some endpoints or target applications. This is because the operators function uses default query strings to communicate with the endpoint, and some endpoints may not support the default query strings as they use custom formats.

      Tip: If you selected the parameter type as Date, you can use values such as ISO, Coordinated Universal Time (UTC), Epoch, or other custom raw formats. For a list of custom raw formats, see List of common date time formats for Moment.js.
      Note: The Location field represents the type of parameter that you chose, that is Query or header parameter, and cannot be changed.

7. Click Apply changes.