Field properties: QBL v0.15

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

Format

True

-

One of: International, United States

InputWidth

False

60

Any integer

DefaultMapType

False

Road

One of: Road, Satellite, Hybrid, Terrain

Street1

True

-

Reference to QB::Field::AddressStreet1
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    AddToAllNewReports

This property sets the availability of the field in the Default Report Columns. When set to true, the field will be part of the Default Report Columns, unless the  field has some role permissions restrictions

False

False

true or false

Street2

True

-

Reference to QB::Field::AddressStreet2
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    AddToAllNewReports

This property sets the availability of the field in the Default Report Columns. When set to true, the field will be part of the Default Report Columns, unless the  field has some role permissions restrictions

False

False

true or false

City

True

-

Reference to QB::Field::AddressCity
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    AddToAllNewReports

This property sets the availability of the field in the Default Report Columns. When set to true, the field will be part of the Default Report Columns, unless the  field has some role permissions restrictions

False

False

true or false

State

True

-

Reference to QB::Field::AddressState
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    AddToAllNewReports

This property sets the availability of the field in the Default Report Columns. When set to true, the field will be part of the Default Report Columns, unless the  field has some role permissions restrictions

False

False

true or false

    Options

False

Default

Array of items of type: Any string
Any string

PostalCode

True

-

Reference to QB::Field::AddressPostalCode
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    AddToAllNewReports

This property sets the availability of the field in the Default Report Columns. When set to true, the field will be part of the Default Report Columns, unless the  field has some role permissions restrictions

False

False

true or false

Country

True

-

Reference to QB::Field::AddressCountry
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    AddToAllNewReports

This property sets the availability of the field in the Default Report Columns. When set to true, the field will be part of the Default Report Columns, unless the  field has some role permissions restrictions

False

False

true or false

    Options

False

Default

Array of items of type: Any string
Any string

Label

True

-

Any string

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

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

DefaultValue

False

Unchecked

One of: Unchecked, Checked

ShowAsCheckmark

False

True

true or false

DoesTotal

False

False

true or false

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

-

See nested properties

    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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

SharedWith

False

[]

Array of items of type: Any string

IsAuditable

False

False

true or false

Label

False

Date Created

Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

SharedWith

False

[]

Array of items of type: Any string

IsAuditable

False

False

true or false

Label

False

Date Modified

Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

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

Comments

False

""

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

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

SharedWith

False

[]

Array of items of type: Any string

IsAuditable

False

False

true or false

Label

False

Last Modified By

Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

Choices

False

-

See nested properties

    UserSet

False

Default

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

    AllowCreateChoices

False

True

true or false

    AllowInviteExternalUser

False

True

true or false

DefaultValue

False

None

One of: CurrentUser, None

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

Lookup

True

-

See nested properties

    Relationship

True

-

Reference to QB::Relationship::Child

    TargetField

True

-

One of: None

    DisplayType

True

-

Any string

    OverrideSubFieldAccess

False

False

true or false

    DisplayAsLinkToParent

False

False

true or false

SharedWith

False

[]

Array of items of type: Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

DefaultValue

False

""

Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

-

See nested properties

    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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

-

See nested properties

    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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

DefaultValue

False

""

Any string

StartDate

False

Default

One of: Default
References: QB::Field::WorkDate (Scope: parent), QB::Field::WorkDate::Formula (Scope: parent), QB::Field::Lookup (Scope: parent), QB::Field::Summary (Scope: parent), QB::Field::Reference (Scope: parent)

EndDate

False

Default

One of: Default
References: QB::Field::WorkDate (Scope: parent), QB::Field::WorkDate::Formula (Scope: parent), QB::Field::Lookup (Scope: parent), QB::Field::Summary (Scope: parent), QB::Field::Reference (Scope: parent)

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

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

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 QB::Field::Lookup
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: 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, ""
Any integer

DefaultSortOrder

False

Ascending

One of: Ascending, Descending

SeparatorStart

False

4

One of: 3, 4

OverrideSubFieldAccess

False

False

true or false

NumberFormat

False

-

See nested properties

    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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

SharedWith

False

[]

Array of items of type: Any string

Label

False

Record ID#

Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

SharedWith

False

[]

Array of items of type: Any string

IsAuditable

False

False

true or false

Label

False

Record Owner

Any string

IsAuditable

False

False

true or false

SharedWith

False

[]

Array of items of type: Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

Reference

True

-

See nested properties

    Relationship

False

-

-

    Proxy

False

-

-

    DisplayType

False

-

-

    ConditionalValues

False

-

-

    DisplayAsLinkToParent

False

-

-

    UseRecordPickerForGridEdit

False

-

-

    Lookup

True

-

See nested properties

        Relationship

False

-

-

        TargetField

False

-

-

        OverrideSubFieldAccess

False

-

-

    Summary

False

-

See nested properties

        ReferenceField

False

-

-

        FieldToSummarize

False

-

-

        Query

False

-

-

        Function

False

-

-

        DrillDownReport

False

-

-

        OverrideSubFieldAccess

False

-

-

        EvaluateOnlyOnChange

False

-

-

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

FieldRelationship

False

-

See nested properties

    Source

False

Default

One of: Default
References: Field (Scope: parent)

    Target

False

Default

One of: Default, Unsupported
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

MatchValuesExactly

False

True

true or false

UseNewWindow

False

False

true or false

LinkText

False

""

Any string

Label

True

-

Any string

Comments

False

""

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

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

MaxLength

False

0

Any integer

DefaultValue

False

""

Any string

EditHistory

False

-

See nested properties

    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

Height

False

6

Any integer

AllowMentions

False

False

true or false

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

Summary

False

-

See nested properties

    ReferenceField

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

True

-

-

    FieldToSummarize

True

-

Reference to Field

    DisplayType

True

-

Any string

    Function

True

-

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

    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

SharedWith

False

[]

Array of items of type: Any string

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

IsUnique

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

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
See nested properties

    DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

    Lookup

True

-

See nested properties

        Relationship

True

-

Reference to QB::Relationship::Child

        TargetField

True

-

One of: None

        DisplayType

True

-

Any string

        OverrideSubFieldAccess

False

False

true or false

        DisplayAsLinkToParent

False

False

true or false

    SharedWith

False

[]

Array of items of type: Any string

SharedWith

False

[]

Array of items of type: Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: string), Required: False

MaxLength

False

0

Any integer

DefaultValue

False

""

Any string

EditHistory

False

-

See nested properties

    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

DefaultColumnWidth

Should be a value between 20 px and 800 px.

False

-

Any integer

IsAuditable

False

False

true or false

InputOptions

True

-

See nested properties

    InputType

True

-

One of: UserInput, FromList, FromAnotherField

    ListChoices

True

-

Array of items of type: Any string

    AllowCreateChoices

False

False

true or false

    ChoiceOrder

False

AsEntered

One of: AsEntered, Alphabetical

    Target

False

Default

One of: Default
References: Field (Scope: parent), Field (Scope: Root), Field (Scope: Solution)
See nested properties

        TableId

True

-

Any string

        FieldId

True

-

Any integer

Label

True

-

Any string

IsRequired

False

False

true or false

AllowDataCopy

False

True

true or false

Comments