Models

A package for objects in Python and mapping them to QuickBase-expected JSON.

QuickbaseApp

class quickbase_client.QuickbaseApp(app_id: str, realm_hostname: str, name: str)

Class for a QuickBase app.

app_id: str
name: str
realm_hostname: str

QuickbaseTable

class quickbase_client.QuickbaseTable(**kwargs)

Base class for a table object.

Variables

  • __dbid__ – The string table ID (the part after /db in the URL).

  • __tablename__ – The english name of the table.

  • __app__ – The QuickbaseApp the table belongs to.

  • __reports__ – Lookup of QuickbaseReport objects for this table.

  • schema – The object to reference field types (rather than field data).

classmethod app_id() → str

Alias to the app’s ID.

classmethod client(user_token: str, **kwargs)

Factory method to create a QuickbaseTableClient for this table.

Parameters
classmethod get_attr_from_fid(fid: int)

Lookup an attribute name by it’s field ID.

Parameters

fid – The field ID.

classmethod get_field_info(attr: str) → quickbase_client.orm.field.QuickbaseField

Get the field info for a given attribute rather than the data.

Parameters

attr – String name of the attribute.

classmethod get_report(name: str)

Get a report by it’s name.

Parameters

name – The name of the report

classmethod realm_hostname() → str

Alias to the app’s realm hostname.


QuickbaseField

class quickbase_client.QuickbaseField(fid: int, field_type: quickbase_client.orm.field.QuickbaseFieldType, label: str = '', formula: Optional[str] = None)

The metadata for a specific field.

Variables

  • fid (int) – The field id.

  • field_type (QuickbaseFieldType) – The QuickbaseFieldType of the field.

  • label (str) – The label for the field.

  • formula (Optional[str]) – The Quickbase string formula.


QuickbaseFieldType

class quickbase_client.QuickbaseFieldType(value)

An Enumeration of Field Types.

Note

Formula fields use the underlying type.

In the generated classes, the import for this class is usually aliased as Qb to make it easier to write like Qb.TEXT.

These also all have constants in quickbase_client.orm.field module prefixed with QB_.

ADDRESS = 500
CHECKBOX = 400
DATE = 300
DATETIME = 301
DURATION = 303
EMAIL_ADDRESS = 501
NUMERIC = 200
NUMERIC_CURRENCY = 201
NUMERIC_PERCENT = 202
NUMERIC_RATING = 203
OTHER = 900
RICH_TEXT = 103
TEXT = 100
TEXT_MULTILINE = 101
TEXT_MULTIPLE_CHOICE = 102
TEXT_MULTI_SELECT = 102
TIME_OF_DAY = 302
USER = 600