Skip to content
  • There are no suggestions because the search field is empty.

Defining API Variables

Learn how to define variables to augment or override an API Set's base URL:

An API set has one base endpoint URL, but individual functions often need a different path - or a different endpoint entirely. Variables let you adjust or override the base URL per function.

URL Parameters (appended to a request)

  • On the API Variables ribbon, enable Auto Build Request
    • Set the sequence order and name the parameter
    • Choose a value type:
      • Text Value or Key Value Text
    • Choose a processing type:
      • Static or Parameter Record

 

URL Paths

A unique endpoint path for one function. Setup mirrors URL Parameters:

  • Enable Auto Build Request, name the variable, select Text Value, choose a processing type, then enter a static value or parameter record details

 

URL Overrides

Replaces the API set's base endpoint entirely for one function:

  • Enable Auto Build Request, name the variable, select Text Value and Static, then enter the replacement URL

 

 ➡️Next Step: Defining API Mappings