Skip to content

Populating parameters with API Query

Overview

This page covers populating URI, Query, and Header parameters (Params) used in the API Query component. On this page, users will learn how to specify these Params in the API Query component once they have been created in the Manage Query Profiles wizard.

Populating URI, query, and header parameters

Type: Connection

If you create a URI parameter, Query parameter, or Header parameter of type Connection, then you must also specify this parameter within the API Query component. To do this, use the following steps:

  1. Click on the API Query component, and click into the Connection Options property.
  2. Click + to add a new connection option.
  3. Set the connection option's Parameter as Other.
  4. Set the connection option's Value as a list of the parameters and their values, separating each param=value pair with a semicolon and a space. For example: Param1=Value1; Param2=Value2

Type: Input

If you create a URI parameter, Query parameter, or Header parameter of type Input, then you must also specify this parameter within the API Query component. To do this, use the following steps:

  1. Click on the API Query component, and click into the Connection Options property.
  2. Click + to add a new connection option.
  3. Set the connection option's Parameter as PseudoColumns.
  4. Set the connection option's Value as *=*.
  5. Exit the Connection Options dialog, and click into the Data Source Filter property.
  6. Click + to add a new filter. You must add a new filter for each URI, Query, and Header parameter that requires a value.
  7. The Input Column should list all available parameters (made available by setting the PseudoColumns connection option earlier).
  8. Assign an appropriate value to each filter.