Interface CreateFieldResponse

interface CreateFieldResponse {
    appearsByDefault?: boolean;
    audited?: boolean;
    bold?: boolean;
    doesDataCopy?: boolean;
    fieldHelp?: string;
    fieldType?: string;
    findEnabled?: boolean;
    id: number;
    label?: string;
    mode?: string;
    noWrap?: boolean;
    permissions?: { permissionType?: string; role?: string; roleId?: number }[];
    properties?: {
        abbreviate?: boolean;
        allowHTML?: boolean;
        allowMentions?: boolean;
        allowNewChoices?: boolean;
        appearsAs?: string;
        appendOnly?: boolean;
        autoSave?: boolean;
        blankIsZero?: boolean;
        carryChoices?: boolean;
        choices?: string[];
        choicesLuid?: string[];
        commaStart?: number;
        comments?: string;
        compositeFields?: (number | Record<string, unknown>)[];
        coverText?: string;
        currencyFormat?: "left" | "right" | "middle";
        currencySymbol?: string;
        decimalPlaces?: number;
        defaultCountryCode?: string;
        defaultDomain?: string;
        defaultKind?: string;
        defaultToday?: boolean;
        defaultValue?: string;
        defaultValueLuid?: number;
        displayAsLink?: boolean;
        displayCheckboxAsText?: boolean;
        displayDayOfWeek?: boolean;
        displayEmail?: string;
        displayMonth?: string;
        displayRelative?: boolean;
        displayTime?: boolean;
        displayTimezone?: boolean;
        displayUser?: string;
        doesAverage?: boolean;
        doesTotal?: boolean;
        durationField?: number;
        exact?: boolean;
        foreignKey?: boolean;
        format?: number;
        formula?: string;
        hasExtension?: boolean;
        hours24?: boolean;
        linkText?: string;
        lookupReferenceFieldId?: number;
        lookupTargetFieldId?: number;
        masterChoiceFieldId?: number;
        masterChoiceTableId?: string;
        masterTableTag?: string;
        maxLength?: number;
        maxVersions?: number;
        numberFormat?: number;
        numLines?: number;
        parentFieldId?: number;
        seeVersions?: boolean;
        snapFieldId?: number;
        sortAlpha?: boolean;
        sortAsGiven?: boolean;
        sourceFieldId?: number;
        startField?: number;
        summaryFunction?:
            | "AVG"
            | "SUM"
            | "MAX"
            | "MIN"
            | "STD-DEV"
            | "COUNT"
            | "COMBINED-TEXT"
            | "COMBINED-USER"
            | "DISTINCT-COUNT";
        summaryReferenceFieldId?: number;
        summaryTargetFieldId?: number;
        targetFieldId?: number;
        targetTableId?: string;
        targetTableName?: string;
        units?: string;
        useI18NFormat?: boolean;
        useNewWindow?: boolean;
        versionMode?: "keepallversions"
        | "keeplastversions";
        width?: number;
        workWeek?: number;
        xmlTag?: string;
        [key: string]: unknown;
    };
    required?: boolean;
    unique?: boolean;
    [key: string]: unknown;
}

Indexable

[key: string]: unknown

Index

Properties

appearsByDefault? audited? bold? doesDataCopy? fieldHelp? fieldType? findEnabled? id label? mode? noWrap? permissions? properties? required? unique?

Properties

`Optional`appearsByDefault

appearsByDefault?: boolean

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

`Optional`audited

audited?: boolean

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

`Optional`bold

bold?: boolean

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

`Optional`doesDataCopy

doesDataCopy?: boolean

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

`Optional`fieldHelp

fieldHelp?: string

The configured help text shown to users within the product.

`Optional`fieldType

fieldType?: string

The type of field, as described here.

`Optional`findEnabled

findEnabled?: boolean

Indicates if the field is marked as searchable.

id

id: number

The id of the field, unique to this table.

`Optional`label

label?: string

The label (name) of the field.

`Optional`mode

mode?: string

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.

`Optional`noWrap

noWrap?: boolean

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

`Optional`permissions

permissions?: { permissionType?: string; role?: string; roleId?: number }[]

Field Permissions for different roles.

Type Declaration

OptionalpermissionType?: string
The permission given to the role for this field
Optionalrole?: string
The role associated with a given permission for the field
OptionalroleId?: number
The Id of the given role

`Optional`properties

properties?: {
    abbreviate?: boolean;
    allowHTML?: boolean;
    allowMentions?: boolean;
    allowNewChoices?: boolean;
    appearsAs?: string;
    appendOnly?: boolean;
    autoSave?: boolean;
    blankIsZero?: boolean;
    carryChoices?: boolean;
    choices?: string[];
    choicesLuid?: string[];
    commaStart?: number;
    comments?: string;
    compositeFields?: (number | Record<string, unknown>)[];
    coverText?: string;
    currencyFormat?: "left" | "right" | "middle";
    currencySymbol?: string;
    decimalPlaces?: number;
    defaultCountryCode?: string;
    defaultDomain?: string;
    defaultKind?: string;
    defaultToday?: boolean;
    defaultValue?: string;
    defaultValueLuid?: number;
    displayAsLink?: boolean;
    displayCheckboxAsText?: boolean;
    displayDayOfWeek?: boolean;
    displayEmail?: string;
    displayMonth?: string;
    displayRelative?: boolean;
    displayTime?: boolean;
    displayTimezone?: boolean;
    displayUser?: string;
    doesAverage?: boolean;
    doesTotal?: boolean;
    durationField?: number;
    exact?: boolean;
    foreignKey?: boolean;
    format?: number;
    formula?: string;
    hasExtension?: boolean;
    hours24?: boolean;
    linkText?: string;
    lookupReferenceFieldId?: number;
    lookupTargetFieldId?: number;
    masterChoiceFieldId?: number;
    masterChoiceTableId?: string;
    masterTableTag?: string;
    maxLength?: number;
    maxVersions?: number;
    numberFormat?: number;
    numLines?: number;
    parentFieldId?: number;
    seeVersions?: boolean;
    snapFieldId?: number;
    sortAlpha?: boolean;
    sortAsGiven?: boolean;
    sourceFieldId?: number;
    startField?: number;
    summaryFunction?:
        | "AVG"
        | "SUM"
        | "MAX"
        | "MIN"
        | "STD-DEV"
        | "COUNT"
        | "COMBINED-TEXT"
        | "COMBINED-USER"
        | "DISTINCT-COUNT";
    summaryReferenceFieldId?: number;
    summaryTargetFieldId?: number;
    targetFieldId?: number;
    targetTableId?: string;
    targetTableName?: string;
    units?: string;
    useI18NFormat?: boolean;
    useNewWindow?: boolean;
    versionMode?: "keepallversions"
    | "keeplastversions";
    width?: number;
    workWeek?: number;
    xmlTag?: string;
    [key: string]: unknown;
}

Additional properties for the field. Please see Field type details page for more details on the properties for each field type.

Type Declaration

[key: string]: unknown
Optionalabbreviate?: boolean
Don't show the URL protocol when showing the URL.
OptionalallowHTML?: boolean
Whether this field allows html.
OptionalallowMentions?: boolean
If someone can

Mention
users in the rich text field to generate an email notification.
OptionalallowNewChoices?: boolean
Indicates if users can add new choices to a selection list.
OptionalappearsAs?: string
The link text, if empty, the url will be used as link text.
OptionalappendOnly?: boolean
Whether this field is append only.
OptionalautoSave?: boolean
Whether the link field will auto save.
OptionalblankIsZero?: boolean
Whether a blank value is treated the same as 0 in calculations within the product.
OptionalcarryChoices?: boolean
Whether the field should carry its multiple choice fields when copied.
Optionalchoices?: string[]
An array of entries that exist for a field that offers choices to the user.
OptionalchoicesLuid?: string[]
List of user choices.
OptionalcommaStart?: number
The number of digits before commas display in the product, when applicable.
Optionalcomments?: string
The comments entered on the field properties by an administrator.
OptionalcompositeFields?: (number | Record<string, unknown>)[]
An array of the fields that make up a composite field (e.g., address).
OptionalcoverText?: string
An alternate user friendly text that can be used to display a link in the browser.
OptionalcurrencyFormat?: "left" | "right" | "middle"
The currency format used when displaying field values within the product.
OptionalcurrencySymbol?: string
The current symbol used when displaying field values within the product.
OptionaldecimalPlaces?: number
The number of decimal places displayed in the product for this field.
OptionaldefaultCountryCode?: string
Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.
OptionaldefaultDomain?: string
Default email domain.
OptionaldefaultKind?: string
The user default type.
OptionaldefaultToday?: boolean
Indicates if the field value is defaulted today for new records.
OptionaldefaultValue?: string
The default value configured for a field when a new record is added.
OptionaldefaultValueLuid?: number
Default user id value.
OptionaldisplayAsLink?: boolean
Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
OptionaldisplayCheckboxAsText?: boolean
Indicates whether the checkbox values will be shown as text in reports.
OptionaldisplayDayOfWeek?: boolean
Indicates whether to display the day of the week within the product.
OptionaldisplayEmail?: string
How the email is displayed.
OptionaldisplayMonth?: string
How to display months.
OptionaldisplayRelative?: boolean
Whether to display time as relative.
OptionaldisplayTime?: boolean
Indicates whether to display the time, in addition to the date.
OptionaldisplayTimezone?: boolean
Indicates whether to display the timezone within the product.
OptionaldisplayUser?: string
The configured option for how users display within the product.
OptionaldoesAverage?: boolean
Whether this field averages in reports within the product.
OptionaldoesTotal?: boolean
Whether this field totals in reports within the product.
OptionaldurationField?: number
The duration field id.
Optionalexact?: boolean
Whether an exact match is required for a report link.
OptionalforeignKey?: boolean
Indicates if the field is a foreign key (or reference field) in a relationship.
Optionalformat?: number
The format to display time.
Optionalformula?: string
The formula of the field as configured in Quickbase.
OptionalhasExtension?: boolean
Whether this field has a phone extension.
Optionalhours24?: boolean
Indicates whether or not to display time in the 24-hour format within the product.
OptionallinkText?: string
The configured text value that replaces the URL that users see within the product.
OptionallookupReferenceFieldId?: number
The id of the field that is the reference in the relationship for this lookup.
OptionallookupTargetFieldId?: number
The id of the field that is the target on the master table for this lookup.
OptionalmasterChoiceFieldId?: number
The id of the field that is the reference in the relationship.
OptionalmasterChoiceTableId?: string
The id of the table that is the master in this relationship.
OptionalmasterTableTag?: string
The table alias for the master table in the relationship this field is part of.
OptionalmaxLength?: number
The maximum number of characters allowed for entry in Quickbase for this field.
OptionalmaxVersions?: number
The maximum number of versions configured for a file attachment.
OptionalnumberFormat?: number
The format used for displaying numeric values in the product (decimal, separators, digit group).
OptionalnumLines?: number
The number of lines shown in Quickbase for this text field.
OptionalparentFieldId?: number
The id of the parent composite field, when applicable.
OptionalseeVersions?: boolean
Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
OptionalsnapFieldId?: number
The id of the field that is used to snapshot values from, when applicable.
OptionalsortAlpha?: boolean
Whether to sort alphabetically, default sort is by record ID.
OptionalsortAsGiven?: boolean
Indicates if the listed entries sort as entered vs alphabetically.
OptionalsourceFieldId?: number
The id of the source field.
OptionalstartField?: number
The start field id.
OptionalsummaryFunction?:
    | "AVG"
    | "SUM"
    | "MAX"
    | "MIN"
    | "STD-DEV"
    | "COUNT"
    | "COMBINED-TEXT"
    | "COMBINED-USER"
    | "DISTINCT-COUNT"
The summary accumulation function type.
OptionalsummaryReferenceFieldId?: number
The id of the field that is the reference in the relationship for this summary.
OptionalsummaryTargetFieldId?: number
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).
OptionaltargetFieldId?: number
The id of the target field.
OptionaltargetTableId?: string
The id of the target table.
OptionaltargetTableName?: string
The field's target table name.
Optionalunits?: string
The units label.
OptionaluseI18NFormat?: boolean
Whether phone numbers should be in E.164 standard international format.
OptionaluseNewWindow?: boolean
Indicates if the URL should open a new window when a user clicks it within the product.
OptionalversionMode?: "keepallversions" | "keeplastversions"
Version modes for files. Keep all versions vs keep last version.
Optionalwidth?: number
The field's html input width in the product.
OptionalworkWeek?: number
The work week type.
OptionalxmlTag?: string
The field's xml tag.

`Optional`required

required?: boolean

Indicates if the field is marked required.

`Optional`unique

unique?: boolean

Indicates if the field is marked unique.

Interface CreateFieldResponse

Indexable

Index

Properties

Properties

OptionalappearsByDefault

Optionalaudited

Optionalbold

OptionaldoesDataCopy

OptionalfieldHelp

OptionalfieldType

OptionalfindEnabled

id

Optionallabel

Optionalmode

OptionalnoWrap

Optionalpermissions

Type Declaration

OptionalpermissionType?: string

Optionalrole?: string

OptionalroleId?: number

Optionalproperties

Type Declaration

[key: string]: unknown

Optionalabbreviate?: boolean

OptionalallowHTML?: boolean

OptionalallowMentions?: boolean

Mention

OptionalallowNewChoices?: boolean

OptionalappearsAs?: string

OptionalappendOnly?: boolean

OptionalautoSave?: boolean

OptionalblankIsZero?: boolean

OptionalcarryChoices?: boolean

Optionalchoices?: string[]

OptionalchoicesLuid?: string[]

OptionalcommaStart?: number

Optionalcomments?: string

OptionalcompositeFields?: (number | Record<string, unknown>)[]

OptionalcoverText?: string

OptionalcurrencyFormat?: "left" | "right" | "middle"

OptionalcurrencySymbol?: string

OptionaldecimalPlaces?: number

OptionaldefaultCountryCode?: string

OptionaldefaultDomain?: string

OptionaldefaultKind?: string

OptionaldefaultToday?: boolean

OptionaldefaultValue?: string

OptionaldefaultValueLuid?: number

OptionaldisplayAsLink?: boolean

OptionaldisplayCheckboxAsText?: boolean

OptionaldisplayDayOfWeek?: boolean

OptionaldisplayEmail?: string

OptionaldisplayMonth?: string

OptionaldisplayRelative?: boolean

OptionaldisplayTime?: boolean

OptionaldisplayTimezone?: boolean

OptionaldisplayUser?: string

OptionaldoesAverage?: boolean

OptionaldoesTotal?: boolean

OptionaldurationField?: number

Optionalexact?: boolean

OptionalforeignKey?: boolean

Optionalformat?: number

Optionalformula?: string

OptionalhasExtension?: boolean

Optionalhours24?: boolean

OptionallinkText?: string

OptionallookupReferenceFieldId?: number

OptionallookupTargetFieldId?: number

OptionalmasterChoiceFieldId?: number

OptionalmasterChoiceTableId?: string

OptionalmasterTableTag?: string

OptionalmaxLength?: number

OptionalmaxVersions?: number

OptionalnumberFormat?: number

OptionalnumLines?: number

OptionalparentFieldId?: number

OptionalseeVersions?: boolean

OptionalsnapFieldId?: number

`Optional`appearsByDefault

`Optional`audited

`Optional`bold

`Optional`doesDataCopy

`Optional`fieldHelp

`Optional`fieldType

`Optional`findEnabled

`Optional`label

`Optional`mode

`Optional`noWrap

`Optional`permissions

`Optional`permissionType?: string

`Optional`role?: string

`Optional`roleId?: number

`Optional`properties

`Optional`abbreviate?: boolean

`Optional`allowHTML?: boolean

`Optional`allowMentions?: boolean

`Optional`allowNewChoices?: boolean

`Optional`appearsAs?: string

`Optional`appendOnly?: boolean

`Optional`autoSave?: boolean

`Optional`blankIsZero?: boolean

`Optional`carryChoices?: boolean

`Optional`choices?: string[]

`Optional`choicesLuid?: string[]

`Optional`commaStart?: number

`Optional`comments?: string

`Optional`compositeFields?: (number | Record<string, unknown>)[]

`Optional`coverText?: string

`Optional`currencyFormat?: "left" | "right" | "middle"

`Optional`currencySymbol?: string

`Optional`decimalPlaces?: number

`Optional`defaultCountryCode?: string

`Optional`defaultDomain?: string

`Optional`defaultKind?: string

`Optional`defaultToday?: boolean

`Optional`defaultValue?: string

`Optional`defaultValueLuid?: number

`Optional`displayAsLink?: boolean

`Optional`displayCheckboxAsText?: boolean

`Optional`displayDayOfWeek?: boolean

`Optional`displayEmail?: string

`Optional`displayMonth?: string

`Optional`displayRelative?: boolean

`Optional`displayTime?: boolean

`Optional`displayTimezone?: boolean

`Optional`displayUser?: string

`Optional`doesAverage?: boolean

`Optional`doesTotal?: boolean

`Optional`durationField?: number

`Optional`exact?: boolean

`Optional`foreignKey?: boolean

`Optional`format?: number

`Optional`formula?: string

`Optional`hasExtension?: boolean

`Optional`hours24?: boolean

`Optional`linkText?: string

`Optional`lookupReferenceFieldId?: number

`Optional`lookupTargetFieldId?: number

`Optional`masterChoiceFieldId?: number

`Optional`masterChoiceTableId?: string

`Optional`masterTableTag?: string

`Optional`maxLength?: number

`Optional`maxVersions?: number

`Optional`numberFormat?: number

`Optional`numLines?: number

`Optional`parentFieldId?: number

`Optional`seeVersions?: boolean

`Optional`snapFieldId?: number

`Optional`sortAlpha?: boolean

`Optional`sortAsGiven?: boolean

`Optional`sourceFieldId?: number

`Optional`startField?: number

`Optional`summaryFunction?:
| "AVG"
| "SUM"
| "MAX"
| "MIN"
| "STD-DEV"
| "COUNT"
| "COMBINED-TEXT"
| "COMBINED-USER"
| "DISTINCT-COUNT"

`Optional`summaryReferenceFieldId?: number

`Optional`summaryTargetFieldId?: number

`Optional`targetFieldId?: number

`Optional`targetTableId?: string

`Optional`targetTableName?: string