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

    Interface RunQueryResponse

    interface RunQueryResponse {
        data?: QuickbaseRecord[];
        fields?: {
            id?: number;
            label?: string;
            type?: string;
            [key: string]: unknown;
        }[];
        metadata?: {
            numFields: number;
            numRecords: number;
            skip?: number;
            top?: number;
            totalRecords: number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    An array of objects that either represents the record data or summarized values, depending on the report type.

    fields?: { id?: number; label?: string; type?: string; [key: string]: unknown }[]

    An array of objects that contains limited meta-data of each field displayed in the report. This assists in building logic that depends on field types and IDs.

    Type Declaration

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

      Field id.

    • Optionallabel?: string

      Field label.

    • Optionaltype?: string

      Field type.

    metadata?: {
        numFields: number;
        numRecords: number;
        skip?: number;
        top?: number;
        totalRecords: number;
        [key: string]: unknown;
    }

    Additional information about the results that may be helpful. Pagination may be needed if either you specify a smaller number of results to skip than is available, or if the API automatically returns fewer results. numRecords can be compared to totalRecords to determine if further pagination is needed.

    Type Declaration

    • [key: string]: unknown
    • numFields: number

      The number of fields in each record in the current response object

    • numRecords: number

      The number of records in the current response object

    • Optionalskip?: number

      The number of records to skip

    • Optionaltop?: number

      If present, the maximum number of records requested by the caller

    • totalRecords: number

      The total number of records in the result set