BUILTIN.RELATIVE_RANGES

This function returns dynamic calendar ranges for the filter options that apply to relative date fields (such as Last Fiscal Year and Current Week).

Parameters

Parameter

Required / Optional

Description

Accepted Parameter Values

Range ID

Required

The supported date ranges in relative dates.

See RelativeDate.dateId Property values in the table on query.RelativeDateRange for list of supported values.

For example, use 'LFY' to represent Last Fiscal Year in your queries.

Range type

Required

Represents supported period range filters.

  • 'START'

  • 'END'

Date flag

Optional

Represents ways to present date values.

    • 'DATE'

    • 'DATETIME_AS_DATE'

    • 'DATE_FROM_GMT_TO_USER_TZ'

    • 'DATE_TO_USER_TZ'

    • 'ODBC_DATE_TO_GMT'

    • 'ODBC_TIMESTAMP_TO_GMT'

    • 'ODBC_TIMESTAMP_TO_GMT_AS_DATE'

    • 'TIMESTAMP_WITH_TIMEZONE'

    • 'TIMESTAMP_WITH_TIMEZONE_AS_DATE'

Syntax

            BUILTIN.RELATIVE_RANGES('LFYTD', 'START') 

          
            BUILTIN.RELATIVE_RANGES('LFYTD', 'END', 'DATETIME_AS_DATE') 

          

Related Topics

General Notices