Field properties: QBL v0.2

Prev Next

This article contains information about QBL objects. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties.

The following tables list information about the properties of each object.

See general information about fields as QBL objects.

Address fields

In Quickbase, address fields include 6 subfields. Each subfield is also listed in this section.

Address properties

Property

Required

Default

Allowed Values

Format

True

 

One of: International, United States

InputWidth

False

60

Any integer

DefaultMapType

False

Road

One of: Road, Satellite, Hybrid, Terrain

Street1

True

 

Street1

Street2

True

 

Street2

City

True

 

City

State

True

 

State

PostalCode

True

 

PostalCode

Country

True

 

Country

Label

True

 

Any string

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

RolePermissions

False

 

 

Street1 properties

This QBL object does not have any properties. 

Street2 properties

This QBL object does not have any properties. 

City properties

This QBL object does not have any properties. 

State properties

Property

Required

Default

Allowed Values

Options

False

Default

Array of items of type: Any string
Any string

Postal Code properties

This QBL object does not have any properties. 

Country properties

Property

Required

Default

Allowed Values

Options

False

Default

Array of items of type: Any string

Any string

Checkbox fields

Property

Required

Default

Allowed Values

Label

True

-

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

-

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

 

DefaultValue

False

Unchecked

One of: Unchecked, Checked

ShowAsCheckmark

False

True

true or false

DoesTotal

False

False

true or false

Currency fields

Property

Description

Required

Default

Allowed Values

InputOptions

-

False

-

-

InputType

 

False

UserInput

One of: UserInput, FromList

ListChoices

 

True

-

Array of items of type: Any string

AllowCreateChoices

 

False

False

true or false

IsUnique

 

False

False

true or false

Label

 

True

-

Any string

IsRequired

 

False

False

true or false

AllowDataCopy

 

False

True

true or false

IsBold

 

False

False

true or false

DisplayWithoutWrapping

 

False

False

true or false

HelpText

 

False

""

Any string

IsSearchable

 

False

False

true or false

AllowedInReports

 

False

True

true or false

AddToAllNewReports

 

False

False

true or false

SnapshotSourceLookupField

 

True

-

Reference to Field

SharedWith

 

False

[]

Array of items of type: Any string

RolePermissions

 

False

-

 

Units

 

False

""

Any string

Width

 

False

10

Any integer

DoesTotal

 

False

True

true or false

DoesAverage

 

False

False

true or false

TreatBlankAsZero

 

False

True

true or false

DefaultValue

 

False

""

One of: "", Any string

DecimalPlaces

Leave blank for floating point

False

2

One of: FloatingPoint, "", Any integer

DefaultSortOrder

 

False

Ascending

One of: Ascending, Descending

SeparatorStart

 

False

3

One of: 3, 4

OverrideSubFieldAccess

 

False

False

true or false

NumberFormat

 

False

-

-

SeparatorStyle

Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces).

False

CommaGroupingPeriodDecimal

One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal

SeparatorPlaces

 

False

3

One of: none, 2, 3

CurrencySymbol

 

False

$

Any string

CurrencySymbolPosition

 

False

Between

One of: Before, Between, After

Date fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

-

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

-

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

 

ShowMonthAsAlpha

False

False

true or false

HideCurrentYear

False

False

true or false

ShowDayOfWeek

False

False

true or false

DefaultIsToday

False

False

true or false

DefaultSortOrder

False

Ascending

One of: Ascending, Descending

Date created fields

Property

Required

Default

Allowed Values

Label

False

Date Created

Any string

Date modified fields

Property

Required

Default

Allowed Values

Label

False

Date Modified

Any string

Date/time fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

ShowMonthAsAlpha

False

False

true or false

HideCurrentYear

False

False

true or false

ShowDayOfWeek

False

False

true or false

ShowTimeZone

False

False

true or false

ShowTime

False

True

true or false

DefaultIsNow

False

False

true or false

DefaultSortOrder

False

Ascending

One of: Ascending, Descending

Duration fields

Property

Description

Required

Default

Allowed Values

Label

 

True

 

Any string

IsRequired

 

False

False

true or false

AllowDataCopy

 

False

True

true or false

IsBold

 

False

False

true or false

DisplayWithoutWrapping

 

False

False

true or false

HelpText

 

False

""

Any string

IsSearchable

 

False

False

true or false

AllowedInReports

 

False

True

true or false

AddToAllNewReports

 

False

False

true or false

SnapshotSourceLookupField

 

True

 

Reference to Field

SharedWith

 

False

[]

Array of items of type: Any string

RolePermissions

 

False

 

 

TreatBlankAsZero

Treat blank as zero in calculations

False

True

true or false

DoesTotal

Display a total of this field in reports

False

False

true or false

DoesAverage

Display an average of this field in reports

False

True

true or false

DefaultValue

 

False

""

Any string

DecimalPlaces

Leave blank for floating point

False

FloatingPoint

One of: FloatingPoint, ""
Any integer

DisplayUnits

 

False

Smart Units

One of: HH::MM, HH:MM:SS, :MM, :MM:SS, Smart Units, Weeks, Days, Hours, Minutes, Seconds

AddFieldToAllNewReports

Add this field to all new reports

False

True

true or false

Email fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

Comments

False

""

Any string

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to QB::Field::Lookup

SharedWith

False

[]

Any string

RolePermissions

False

 

 

DefaultValue

False

""

Any string

DefaultDomain

False

""

Any string

SortByDomain

False

False

true or false

EnableEmailAll

False

False

true or false

LinkText

False

""

Any string

DisplayAs

False

FullEmailAddress

One of: FullEmailAddress, OmitDomain, OmitAfterUnderscore

File attachment fields

Property

Required

Default

Allowed Values

RevisionsToKeep

False

3

Any string

AllowPromoteVersion

False

True

true or false

UseNewBrowserWindow

False

True

true or false

AllowOpenAccess

False

False

true or false

LinkText

False

""

Any string

ShowAsImages

False

True

true or false

Label

True

 

Any string

IsRequired

False

False

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

Last modified by fields

Property

Required

Default

Allowed Values

Label

False

Last Modified By

Any string

List user fields

Property

Required

Default

Allowed Values

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

*Choices

False

 

-

UserSet

False

Default

One of: Default
Array of items of type: Any string

AllowCreateChoices

False

False

true or false

AllowInviteExternalUser

False

False

true or false

DefaultValue

False

""

One of: CurrentUser

*If you have "from list" and the list contains users that are not registered in the realm you are creating/updating, the unregistered users will disappear from the list of choices.

Lookup fields

Property

Required

Default

Allowed Values

Lookup

False

 

 

Relationship

True

 

Reference to QBL: Relationships - child

TargetField

True

 

Reference to Field

TargetFieldType

True

 

Any string

OverrideSubFieldAccess

False

False

true or false

DisplayAsLinkToParent

False

False

true or false

Multi-select text fields

Property

Required

Default

Allowed Values

InputOptions

False

 

 

InputType

False

FromList

One of: UserInput, FromList

ListChoices

True

 

Array of items of type: Any string

AllowCreateChoices

False

True

true or false

ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

DefaultValue

False

""

Any string

Number fields

Property

Description

Required

Default

Allowed Values

InputOptions

 

False

 

 

InputType

 

False

UserInput

One of: UserInput, FromList

ListChoices

 

True

 

Array of items of type: Any string

AllowCreateChoices

 

False

False

true or false

IsUnique

 

False

False

true or false

Label

 

True

 

Any string

IsRequired

 

False

False

true or false

AllowDataCopy

 

False

True

true or false

IsBold

 

False

False

true or false

DisplayWithoutWrapping

 

False

False

true or false

HelpText

 

False

""

Any string

IsSearchable

 

False

False

true or false

AllowedInReports

 

False

True

true or false

AddToAllNewReports

 

False

False

true or false

SnapshotSourceLookupField

 

True

 

Reference to Field

SharedWith

 

False

[]

Array of items of type: Any string

RolePermissions

 

False

 

 

Units

 

False

""

Any string

Width

 

False

10

Any integer

DoesTotal

 

False

True

true or false

DoesAverage

 

False

False

true or false

TreatBlankAsZero

 

False

True

true or false

DefaultValue

 

False

""

One of: ""
Any string

DecimalPlaces

Leave blank for floating point

False

FloatingPoint

One of: FloatingPoint, ""
Any integer

DefaultSortOrder

 

False

Ascending

One of: Ascending, Descending

SeparatorStart

 

False

4

One of: 3, 4

OverrideSubFieldAccess

 

False

False

true or false

NumberFormat

 

False

 

 

SeparatorStyle

Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces).

False

CommaGroupingPeriodDecimal

One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal

SeparatorPlaces

 

False

3

One of: none, 2, 3

Percent fields

Property

Description

Required

Default

Allowed Values

InputOptions

 

True

 

 

InputType

 

True

 

One of: UserInput, FromList

ListChoices

 

True

 

Array of items of type: Any string

AllowCreateChoices

 

False

False

true or false

IsUnique

 

False

False

true or false

Label

 

True

 

Any string

IsRequired

 

False

False

true or false

AllowDataCopy

 

False

True

true or false

Comments

 

False

""

Any string

IsBold

 

False

False

true or false

DisplayWithoutWrapping

 

False

False

true or false

HelpText

 

False

""

Any string

IsSearchable

 

False

False

true or false

AllowedInReports

 

False

True

true or false

AddToAllNewReports

 

False

False

true or false

SnapshotSourceLookupField

 

True

 

Reference to QB::Field::Lookup

SharedWith

 

False

[]

Array of items of type: Any string

RolePermissions

 

False

 

Units

 

False

""

Any string

Width

 

False

10

Any integer

DoesTotal

 

False

True

true or false

DoesAverage

 

False

False

true or false

TreatBlankAsZero

 

False

True

true or false

DefaultValue

 

False

""

One of: ""
Any string

DecimalPlaces

Leave blank for floating point

False

FloatingPoint

One of: FloatingPoint, ""
Any integer

DefaultSortOrder

 

False

Ascending

One of: Ascending, Descending

SeparatorStart

 

False

4

One of: 3, 4

OverrideSubFieldAccess

 

False

False

true or false

NumberFormat

 

False

 

 

SeparatorStyle

Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces).

False

CommaGroupingPeriodDecimal

One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal

SeparatorPlaces

 

False

3

One of: none, 2, 3

Phone number fields

Property

Required

Default

Allowed Values

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

DefaultValue

False

""

Any string

HasExtension

False

True

true or false

IsInternational

False

False

true or false

DefaultCountry

False

US

One of: AF, AL, DZ, AS, AD, AO, AI, AG, AR, AM, AW, AC, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, BQ, KY, CF, TD, CL, CN, CX, CC, CO, KM, CD, CG, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW, AX

Predecessor fields

Property

Required

Default

Allowed Values

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

DefaultValue

False

""

Any string

StartDate

False

Default

One of: Default, Reference to QBL: Work date fields

EndDate

False

Default

One of: Default, Reference to QBL: Work date fields or
QBL: Work date - formula fields

Rating fields

Property

Description

Required

Default

Allowed Values

InputOptions

 

True

 

 

InputType

 

True

 

One of: UserInput, FromList

ListChoices

 

True

 

Array of items of type: Any string

AllowCreateChoices

 

False

False

true or false

IsUnique

 

False

False

true or false

Label

 

True

 

Any string

IsRequired

 

False

False

true or false

AllowDataCopy

 

False

True

true or false

IsBold

 

False

False

true or false

DisplayWithoutWrapping

 

False

True

true or false

HelpText

 

False

""

Any string

IsSearchable

 

False

False

true or false

AllowedInReports

 

False

True

true or false

AddToAllNewReports

 

False

True

true or false

SnapshotSourceLookupField

 

True

 

Reference to Field

SharedWith

 

False

[]

Array of items of type: Any string

RolePermissions

 

False

 

 

Units

 

False

""

Any string

Width

 

False

10

Any integer

DoesTotal

 

False

False

true or false

DoesAverage

 

False

True

true or false

TreatBlankAsZero

 

False

False

true or false

DefaultValue

 

False

""

Any string

DecimalPlaces

Leave blank for floating point

False

1

One of: FloatingPoint, "" or Any integer

DefaultSortOrder

 

False

Ascending

One of: Ascending, Descending

SeparatorStart

 

False

4

One of: 3, 4

OverrideSubFieldAccess

 

False

False

true or false

NumberFormat

 

False

 

 

SeparatorStyle

Whether to use a comma or dot/period as the decimals separator e.g. 766.12 vs 766,12. The other will automatically be used for separating integer digit groupings, if grouped integers are chosen (see SeparatorPlaces).

False

CommaGroupingPeriodDecimal

One of: CommaGroupingPeriodDecimal, PeriodGroupingCommaDecimal

SeparatorPlaces

 

False

3

One of: none, 2, 3

Record ID fields

Property

Required

Default

Allowed Values

Label

False

Record ID#

Any string

Record owner fields

Property

Required

Default

Allowed Values

Label

False

Record Owner

Any string

Reference fields

Property

Required

Default

Allowed Values

Reference

False

 

 

Relationship

True

 

Reference to QB::Relationship::Child

Proxy

True

 

Reference to Field

DisplayType

True

 

Any string

ConditionalValues

True

 

 

FilterField

True

 

Reference to Field

MatchField

True

 

Reference to Field

DisplayAsLinkToParent

False

False

true or false

UseRecordPickerForGridEdit

False

False

true or false

Reference proxy fields

This QBL object does not have any properties. 

Report link fields

Property

Required

Default

Allowed Values

FieldRelationship

False

 

 

Source

False

Default

One of: Default, Reference to Field

Target

False

Default

One of: Default, Unsupported, Reference to Field or Field

MatchValuesExactly

False

True

true or false

UseNewWindow

False

False

true or false

LinkText

False

""

Any string

Label

True

 

Any string

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

IsSearchable

False

False

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

Rich text fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

MaxLength

False

0

Any integer

DefaultValue

False

""

Any string

EditHistory

False

 

 

Enable

False

False

true or false

ExpandedHistory

False

False

true or false

PrependHistory

False

False

true or false

UseFullName

False

True

true or false

IncludeTime

False

False

true or false

IncludeTimeZone

False

False

true or false

Width

False

40

Any integer

Summary fields

Property

Description

Required

Default

Allowed Values

Summary

 

False

 

 

ReferenceField

The foreign key field in the child table that establishes the table to table relationship.

True

 

Reference to QB::Field::Reference

FieldToSummarize

 

True

 

Reference to Field

DisplayType

 

True

 

Any string

Function

 

True

 

One of: Count, Total, Average, Maximum, Minimum, StdDeviation, CombinedText, DistinctCount, AnyRelatedRecords

DrillDownReport

 

False

None

One of: Default, None Any integer

Query

 

False

""

Any string

DisplayAsLinkToChildren

 

False

False

true or false

OverrideSubFieldAccess

 

False

False

true or false

EvaluateOnlyOnChange

 

False

False

true or false

Note: The field caching property is not supported

Text fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

InputOptions

True

-

Nested Property

InputType

True

-

One of: UserInput

ListChoices

True

-

Array of items of type: Any string

AllowCreateChoices

False

True

true or false

ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

Label

True

-

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

Reference to Field

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

MaxLength

False

0

Any integer

DefaultValue

False

""

Any string

EditHistory

False

 

 

Enable

False

False

true or false

ExpandedHistory

False

False

true or false

PrependHistory

False

False

true or false

UseFullName

False

True

true or false

IncludeTime

False

False

true or false

IncludeTimeZone

False

False

true or false

Width

False

40

Any integer

Text - multi-line fields

Property

Required

Default

Allowed Values

InputOptions

True

 

 

InputType

True

One of: UserInput, FromList

 

ListChoices

True

Array of items of type: Any string

 

AllowCreateChoices

False

False

true or false

ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

Label

True

Any string

 

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

Reference to Field

 

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

Documentation coming soon

 

MaxLength

False

0

Any integer

DefaultValue

False

""

Any string

EditHistory

False

 

 

Enable

False

False

true or false

ExpandedHistory

False

False

true or false

PrependHistory

False

False

true or false

UseFullName

False

True

true or false

IncludeTime

False

False

true or false

IncludeTimeZone

False

False

true or false

Height

False

6

Any integer

Width

False

40

Any integer

Text - multiple choice fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

InputOptions

True

 

 

InputType

True

One of: UserInput, FromList

 

ListChoices

True

Array of items of type: Any string

 

AllowCreateChoices

False

True

true or false

ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

Label

True

Any string

 

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

Reference to Field

 

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

MaxLength

False

0

Any integer

DefaultValue

False

""

Any string

EditHistory

False

 

 

Enable

False

False

true or false

ExpandedHistory

False

False

true or false

PrependHistory

False

False

true or false

UseFullName

False

True

true or false

IncludeTime

False

False

true or false

IncludeTimeZone

False

False

true or false

Time of day fields

Property

Description

Required

Default

Allowed Values

IsUnique

 

False

False

true or false

Label

 

True

 

Any string

IsRequired

 

False

False

true or false

AllowDataCopy

 

False

True

true or false

IsBold

 

False

False

true or false

DisplayWithoutWrapping

 

False

False

true or false

HelpText

 

False

""

Any string

IsSearchable

 

False

False

true or false

AllowedInReports

 

False

True

true or false

AddToAllNewReports

 

False

False

true or false

SnapshotSourceLookupField

 

True

 

Reference to Field

SharedWith

 

False

[]

Array of items of type: Any string

RolePermissions

 

False

 

 

DefaultValue

 

False

""

Any string

DisplayAs

 

False

HH:MM

One of: HH:MM, HH:MM:SS

Use24HourClock

 

False

False

true or false

ShowTimeZone

 

False

False

true or false

DecimalPlaces

Leave blank for floating point

False

FloatingPoint

One of: FloatingPoint, ""

Any integer

URL fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

 

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

 

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

LinkText

False

""

Any string

DefaultValue

False

""

Any string

Abbreviate

False

False

true or false

DisplayAsButton

False

False

true or false

ButtonColor

False

default

Any string

EmbedAsIframe

False

False

true or false

IframeWidth

False

default

One of: default

Any integer

IframeHeight

False

default

One of: default

Any integer

Target

False

SamePage

One of: SamePage, NewWindow, Popup

User fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

N/A

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

True

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

N/A

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

*Choices

False

 

 

UserSet

False

Default

One of: Default Array of items of type: Any string

AllowCreateChoices

False

False

true or false

AllowInviteExternalUser

False

False

true or false

DefaultValue

False

""

Any string

DisplayAs

False

FirstNameLastName

One of: FirstNameLastName, LastNameFirstName, UserName

*If you have "from list" and the list contains users that are not registered in the realm you are creating/updating, the unregistered users will disappear from the list of choices.

Work date fields

Property

Required

Default

Allowed Values

IsUnique

False

False

true or false

Label

True

N/A

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

IsBold

False

False

true or false

DisplayWithoutWrapping

False

False

true or false

HelpText

False

""

Any string

IsSearchable

False

False

true or false

AllowedInReports

False

True

true or false

AddToAllNewReports

False

False

true or false

SnapshotSourceLookupField

True

N/A

Reference to Field

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

 

 

ShowMonthAsAlpha

False

False

true or false

HideCurrentYear

False

False

true or false

ShowDayOfWeek

False

False

true or false

DefaultIsToday

False

False

true or false

DefaultSortOrder

False

Ascending

One of: Ascending, Descending

Unsupported fields

QB::Field::Unsupported is a placeholder used to represent Fields in an Application that are not supported in the exported QBL version. An example of this is the vCard field.

Unsupported fields will be ignored during Create and Update API actions. If you are updating an application with Unsupported fields (like vCard) and don't have a QB::Field::Unsupported for that field's ID in the template being published, the field will be deleted from the target application.

Property

Description

Required

Default

Allowed Values

Label

Label of the unsupported Field when it was exported. This property is ignored during Create and Update actions.

True

N/A

Any string

Explanation

Unsupported Fields might be exported with an explanation of why it's unsupported when possible. This property is ignored during Create and Update actions.

False

""

Any string