Type alias QuickBaseResponseRunQuery

Type declaration

• data: Record<string, {
      value: any;
  }>[]

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

• fields: {
      id: number;
      label: string;
      type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
  }[]

  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.

• metadata: {
      numFields: number;
      numRecords: number;
      skip?: number;
      top?: number;
      totalRecords: number;
  }

  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.

  • 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

  • Optional skip?: number

    The number of records to skip

  • Optional top?: number

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

  • totalRecords: number

    The total number of records in the result set