Type alias QuickBaseRequestRunQuery

QuickBaseRequestRunQuery: QuickBaseRequest & {
    groupBy?: {
        fieldId: number;
        grouping: "equal-values" | "first-word" | "first-letter" | "equal-values" | "1000000" | "100000" | "10000" | "1000" | "100" | "10" | "1" | ".1" | ".01" | ".001";
    }[];
    options?: {
        compareWithAppLocalTime?: boolean;
        skip: number;
        top: number;
    };
    select?: number[];
    sortBy?: {
        fieldId: number;
        order: "ASC" | "DESC" | "equal-values";
    }[] | false;
    tableId: string;
    where?: string;
}

Type declaration

  • Optional groupBy?: {
        fieldId: number;
        grouping: "equal-values" | "first-word" | "first-letter" | "equal-values" | "1000000" | "100000" | "10000" | "1000" | "100" | "10" | "1" | ".1" | ".01" | ".001";
    }[]

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

  • Optional options?: {
        compareWithAppLocalTime?: boolean;
        skip: number;
        top: number;
    }

    Additional query options.

    • Optional compareWithAppLocalTime?: 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.

    • skip: number

      The number of records to skip.

    • top: number

      The maximum number of records to display.

  • Optional 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.

  • Optional sortBy?: {
        fieldId: number;
        order: "ASC" | "DESC" | "equal-values";
    }[] | false

    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.

  • tableId: string

    The table identifier.

  • Optional 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

Theme