QuickBase JS SDK v2 - v2.2.2
    Preparing search index...

    Interface RunQueryRequest

    Query for data

    interface RunQueryRequest {
        from: string;
        groupBy?: {
            fieldId?: number;
            grouping?: "equal-values";
            [key: string]: unknown;
        }[];
        options?: {
            compareWithAppLocalTime?: boolean;
            skip?: number;
            top?: number;
            [key: string]: unknown;
        };
        select?: number[];
        sortBy?: false
        | SortField[];
        where?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    from groupBy? options? select? sortBy? where?

    Properties

    from: string

    The table identifier.

    groupBy?: {
        fieldId?: number;
        grouping?: "equal-values";
        [key: string]: unknown;
    }[]

    An array that contains the fields to group the records by.

    Type Declaration

    • [key: string]: unknown
    • OptionalfieldId?: number

      The unique identifier of a field in a table.

    • Optionalgrouping?: "equal-values"

      Group by based on equal values (equal-values)

    options?: {
        compareWithAppLocalTime?: boolean;
        skip?: number;
        top?: number;
        [key: string]: unknown;
    }

    Additional query options.

    Type Declaration

    • [key: string]: unknown
    • OptionalcompareWithAppLocalTime?: boolean

      Whether to run the query against a date time field with respect to the application's local time. The query is run with UTC time by default. This parameter is ignored when querying by ISO8601, which is always in UTC.

    • Optionalskip?: number

      The number of records to skip.

    • Optionaltop?: number

      The maximum number of records to display.

    select?: number[]

    An array of field ids for the fields that should be returned in the response. If empty, the default columns on the table will be returned.

    sortBy?: false | SortField[]

    An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance.

    where?: string

    The filter, using the Quickbase query language, which determines the records to return. If this parameter is omitted, the query will return all records.

    Settings

    Member Visibility

    On This Page

    Properties