Show TOC

Background documentationQuery Parameter Types

 

There are many types of parameters. The following list describes the most common parameter types and their formats:

  • String

    String values consist of alphanumeric content in the following formats:

    • Free format like the Title parameter in the ChartServlet.

    • Specific format with a range of values like the Time parameter in a query with a format such as today@08:00:00.

    • Format provided from a finite list of string constants like the DurationUnits parameter.

  • String List

    String lists are passed as comma-delimited string values as in the Columns and Tablesparameters for SQL queries. Several values can be provided in the same parameter name. For example, Columns=EmployeeID,FirstName,LastName,SocialSecurityNo.

  • Date

    Date parameters use a Java date format string. Date and time parameters must be in the DateFormatformat. If the DateFormat is not provided, the default MM/dd/yyyy HH:mm:ss format is applied. If the date parameter is 04/08/2000 14:15:13 and the DateFormat parameter is dd-MMM-yyyy HH:mm, the value is passed as 08-APR-2000 14:15.

  • Boolean

    Boolean parameters are true or false. All parameters accept the following values:

    • True values

      • true

      • yes

      • t

      • y

      • 1

    • False values

      • false

      • no

      • f

      • n

      • 0

  • Integer

    Integer parameter types expect a whole number value.

  • Floating Point

    Floating point parameter types expect a number value, which may include a decimal point and fractional value.