Cmdlets for Quickbase

Build 25.0.9434

FieldDefinitions

Retrieve the properties for all fields in a specific table.

Table Specific Information

Select

The FieldDefinitions table gathers the detailed attributes for each field within a designated table.

The cmdlet retrieves field definitions from the FieldDefinitions table, accessing either all records pertaining to a table or a specific record when multiple criteria are applied. All other filters are executed client-side within the cmdlet.

For example, the following queries are processed server side: 

SELECT * FROM [FieldDefinitions] WHERE [TableId] = 'bvajv8gg2'
SELECT * FROM [FieldDefinitions] WHERE [Id] = '1' AND [TableId] = 'bvady68q6'

Insert

The Quickbase cmdlet inserts a new record into the FieldDefinitions table, creating a new field definition.

For example: 

INSERT INTO FieldDefinitions(Label, FieldType, NoWrap, Bold, AppearsByDefault, FindEnabled, FieldHelp, MaxLength, AppendOnly, SortAsGiven, Permissions, TableId) VALUES('Field1', 'text', false, false, false, true, 'field1 help', 0, false, false, '[{"role":"Viewer","permissionType":"View","roleId":10},{"role":"Participant","permissionType":"None","roleId":11},{"role":"Administrator","permissionType":"Modify","roleId":12}]', 'bvajv8gg2')

Update

The Quickbase cmdlet updates an existing record in the FieldDefinitions table, modifying one or more properties of a field definition identified by specific criteria.

For example: 

UPDATE FieldDefinitions SET Label='UpdatedField1' WHERE [Id] = '6' AND [TableId] = 'bvajv8gg2'

Delete

The Quickbase cmdlet deletes a record from the FieldDefinitions table that matches the specified identifying criteria.

For example: 

DELETE FROM [FieldDefinitions] WHERE [Id] = '6' AND [TableId] = 'bvajv8gg2'

Columns

Name Type ReadOnly References SupportedOperators Description
Id [KEY] Int64 False =

The Id of the field, unique to this table.

FieldType String False

The type of field.

Mode String True

For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.

Label String False

The label (name) of the field.

NoWrap Boolean False

Indicates if the field is configured to not wrap when displayed in the product.

Bold Boolean False

Indicates if the field is configured to display in bold in the product.

Required Boolean False

Indicates if the field is marked required.

AppearsByDefault Boolean False

Indicates if the field is marked as a default in reports.

FindEnabled Boolean False

Indicates if the field is marked as searchable.

Unique Boolean False

Indicates if the field is marked unique.

DoesDataCopy Boolean True

Indicates if the field data will copy when a user copies the record.

FieldHelp String False

The configured help text shown to users within the product.

Audited Boolean False

Indicates if the field is being tracked as part of Quickbase Audit Logs.

AllowMentions Boolean False

If someone can @mention users in the rich text field to generate an email notification.

Comments String False

The comments entered on the field properties by an administrator.

DoesTotal Boolean False

Whether this field totals in reports within the product.

AutoSave Boolean False

Whether the link field will auto save.

DefaultValueLuId Int64 False

Default user Id value.

UseI18NFormat Boolean False

Whether phone numbers should be in E.164 standard international format.

MaxVersions Int64 False

The maximum number of versions configured for a file attachment.

CarryChoices Boolean False

Whether the field should carry its multiple choice fields when copied.

Format Int64 False

The format to display time.

MaxLength Int64 False

The maximum number of characters allowed for entry in Quickbase for this field.

LinkText String False

The configured text value that replaces the URL that users see within the product.

ParentFieldId Int64 False

The Id of the parent composite field, when applicable.

DisplayTimezone Boolean False

Indicates whether to display the timezone within the product.

SummaryTargetFieldId Int64 True

The Id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn't require a field selection (like count).

AllowNewChoices Boolean False

Indicates if users can add new choices to a selection list.

MasterChoiceFieldId Int64 True

The Id of the field that is the reference in the relationship.

DefaultToday Boolean False

Indicates if the field value is defaulted today for new records.

Units String False

The units label.

LookupTargetFieldId Int64 True

The Id of the field that is the target on the master table for this lookup.

SummaryFunction String True

The summary accumulation function type.

SourceFieldId Int64 False

The Id of the source field.

MasterTableTag String True

The table alias for the master table in the relationship this field is part of.

DoesAverage Boolean False

Whether this field averages in reports within the product.

Formula String False

The formula of the field as configured in Quickbase.

DecimalPlaces Int64 False

The number of decimal places displayed in the product for this field.

DefaultCountryCode String False

Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.

SeeVersions Boolean False

Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.

DisplayMonth String False

Indicates how months should be displayed.

NumLines Int64 False

The number of lines shown in Quickbase for this text field.

DisplayEmail String False

Indicates how email should be displayed.

DefaultKind String False

The user default type.

CoverText String False

An alternate user friendly text that can be used to display a link in the browser.

CurrencySymbol String False

The current symbol used when displaying field values within the product.

MasterChoiceTableId String False

The Id of the table that is the master in this relationship.

TargetFieldId Int64 False

The Id of the target field.

DisplayUser String False

The configured option for how users display within the product.

BlankIsZero Boolean False

Whether a blank value is treated the same as 0 in calculations within the product.

Exact Boolean False

Whether an exact match is required for a report link.

StartField Int64 False

The start field Id.

DefaultDomain String False

Default email domain.

DefaultValue String False

The default value configured for a field when a new record is added.

ChoicesLuId String False

List of user choices.

Abbreviate Boolean False

Displays the URL without the protocol.

XmlTag String True

The field's xml tag.

TargetTableName String False

The field's target table name.

NumberFormat Int64 False

The format used for displaying numeric values in the product (decimal, separators, digit group).

AppearsAs String False

The link text, if empty, the url will be used as link text.

Width Int64 False

The field's html input width in the product.

CurrencyFormat String False

The currency format used when displaying field values within the product.

ForeignKey Boolean False

Indicates if the field is a foreign key (or reference field) in a relationship.

DisplayDayOfWeek Boolean False

Indicates whether to display the day of the week within the product.

SummaryReferenceFieldId Int64 True

The Id of the field that is the reference in the relationship for this summary.

CommaStart Int64 False

The number of digits before commas display in the product, when applicable.

Choices String False

An array of entries that exist for a field that offers choices to the user.

TargetTableId String False =

The Id of the target table.

DisplayRelative Boolean False

Whether to display time as relative.

CompositeFields String False

An array of the fields that make up a composite field (e.g., address).

DisplayCheckboxAsText Boolean False

Indicates whether the checkbox values will be shown as text in reports.

VersionMode String False

Version modes for files.

DisplayTime Boolean False

Indicates whether to display the time, in addition to the date.

DurationField Int64 True

The duration field id.

SnapFieldId Int64 False

The Id of the field that is used to snapshot values from, when applicable.

Hours24 Boolean False

Indicates whether or not to display time in the 24-hour format within the product.

SortAlpha Boolean False

Whether to sort alphabetically, default sort is by record Id.

SortAsGiven Boolean False

Indicates if the listed entries sort as entered vs alphabetically.

HasExtension Boolean False

Whether this field has a phone extension.

WorkWeek Int64 True

The work week type.

UseNewWindow Boolean False

Indicates if the URL should open a new window when a user clicks it within the product.

AppendOnly Boolean False

Indicates whether the field is append-only.

DisplayAsLink Boolean False

Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.

AllowHTML Boolean False

Indicates whether HTML content is allowed in this field.

LookupReferenceFieldId Int64 False

The Id of the field that is the reference in the relationship for this lookup.

Permissions String False

Field Permissions for different roles.

TableId [KEY] String False

TableDefinitions.Id

=

The unique identifier (dbid) of the table.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434