Type alias QuickBaseRequestUpdateField

QuickBaseRequestUpdateField: QuickBaseRequest & {
    addToForms?: boolean;
    appearsByDefault?: boolean;
    audited?: boolean;
    bold?: boolean;
    fieldHelp?: string;
    fieldId: number;
    findEnabled?: boolean;
    label?: string;
    noWrap?: boolean;
    permissions?: {
        permissionType: "None" | "View" | "Modify";
        role: string;
        roleId: number;
    }[];
    properties?: {
        abbreviate?: boolean;
        allowNewChoices?: boolean;
        appearsAs?: string;
        appendOnly?: boolean;
        autoSave?: boolean;
        blankIsZero?: boolean;
        carryChoices?: boolean;
        choices?: string[];
        commaStart?: number;
        comments?: string;
        compositeFields?: number[];
        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;
        exact?: boolean;
        format?: number;
        formula?: string;
        hasExtension?: boolean;
        hours24?: boolean;
        linkText?: string;
        lookupReferenceFieldId?: number;
        lookupTargetFieldId?: number;
        maxLength?: number;
        maxVersions?: number;
        numLines?: number;
        numberFormat?: number;
        openTargetIn?: "sameWindow" | "newWindow" | "popup";
        parentFieldId?: number;
        seeVersions?: boolean;
        snapFieldId?: number;
        sortAlpha?: boolean;
        sortAsGiven?: boolean;
        sourceFieldId?: number;
        summaryFunction?: "AVG" | "SUM" | "MAX" | "MIN" | "STD-DEV" | "COUNT" | "COMBINED-TEXT" | "DISTINCT-COUNT";
        summaryQuery?: string;
        summaryReferenceFieldId?: number;
        summaryTableId?: string;
        summaryTargetFieldId?: number;
        targetFieldId?: number;
        targetTableId?: string;
        targetTableName?: string;
        units?: string;
        useI18NFormat?: boolean;
        useNewWindow?: boolean;
        versionMode?: "keepallversions" | "keeplastversions";
        width?: number;
    };
    required?: boolean;
    tableId: string;
    unique?: boolean;
}

Type declaration

  • Optional addToForms?: boolean

    Whether the field you are adding should appear on forms.

  • Optional appearsByDefault?: boolean

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

  • Optional audited?: boolean

    Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under Quickbase Audit Logs.

  • Optional bold?: boolean

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

  • Optional fieldHelp?: string

    The configured help text shown to users within the product.

  • fieldId: number

    The unique identifier (fid) of the field.

  • Optional findEnabled?: boolean

    Indicates if the field is marked as searchable.

  • Optional label?: string

    The label (name) of the field.

  • Optional noWrap?: boolean

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

  • Optional permissions?: {
        permissionType: "None" | "View" | "Modify";
        role: string;
        roleId: number;
    }[]

    Field Permissions for different roles.

  • Optional properties?: {
        abbreviate?: boolean;
        allowNewChoices?: boolean;
        appearsAs?: string;
        appendOnly?: boolean;
        autoSave?: boolean;
        blankIsZero?: boolean;
        carryChoices?: boolean;
        choices?: string[];
        commaStart?: number;
        comments?: string;
        compositeFields?: number[];
        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;
        exact?: boolean;
        format?: number;
        formula?: string;
        hasExtension?: boolean;
        hours24?: boolean;
        linkText?: string;
        lookupReferenceFieldId?: number;
        lookupTargetFieldId?: number;
        maxLength?: number;
        maxVersions?: number;
        numLines?: number;
        numberFormat?: number;
        openTargetIn?: "sameWindow" | "newWindow" | "popup";
        parentFieldId?: number;
        seeVersions?: boolean;
        snapFieldId?: number;
        sortAlpha?: boolean;
        sortAsGiven?: boolean;
        sourceFieldId?: number;
        summaryFunction?: "AVG" | "SUM" | "MAX" | "MIN" | "STD-DEV" | "COUNT" | "COMBINED-TEXT" | "DISTINCT-COUNT";
        summaryQuery?: string;
        summaryReferenceFieldId?: number;
        summaryTableId?: string;
        summaryTargetFieldId?: number;
        targetFieldId?: number;
        targetTableId?: string;
        targetTableName?: string;
        units?: string;
        useI18NFormat?: boolean;
        useNewWindow?: boolean;
        versionMode?: "keepallversions" | "keeplastversions";
        width?: number;
    }

    Specific field properties.

    • Optional abbreviate?: boolean

      Don't show the URL protocol when showing the URL.

    • Optional allowNewChoices?: boolean

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

    • Optional appearsAs?: string

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

    • Optional appendOnly?: boolean

      Whether this field is append only.

    • Optional autoSave?: boolean

      Whether the link field will auto save.

    • Optional blankIsZero?: boolean

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

    • Optional carryChoices?: boolean

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

    • Optional choices?: string[]

      An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.

    • Optional commaStart?: number

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

    • Optional comments?: string

      The comments entered on the field properties by an administrator.

    • Optional compositeFields?: number[]

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

    • Optional coverText?: string

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

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

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

    • Optional currencySymbol?: string

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

    • Optional decimalPlaces?: number

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

    • Optional defaultCountryCode?: 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.

    • Optional defaultDomain?: string

      Default email domain.

    • Optional defaultKind?: string

      The user default type.

    • Optional defaultToday?: boolean

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

    • Optional defaultValue?: string

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

    • Optional defaultValueLuid?: number

      Default user id value.

    • Optional displayAsLink?: boolean

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

    • Optional displayCheckboxAsText?: boolean

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

    • Optional displayDayOfWeek?: boolean

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

    • Optional displayEmail?: string

      How the email is displayed.

    • Optional displayMonth?: string

      How to display months.

    • Optional displayRelative?: boolean

      Whether to display time as relative.

    • Optional displayTime?: boolean

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

    • Optional displayTimezone?: boolean

      Indicates whether to display the timezone within the product.

    • Optional displayUser?: string

      The configured option for how users display within the product.

    • Optional doesAverage?: boolean

      Whether this field averages in reports within the product.

    • Optional doesTotal?: boolean

      Whether this field totals in reports within the product.

    • Optional exact?: boolean

      Whether an exact match is required for a report link.

    • Optional format?: number

      The format to display time.

    • Optional formula?: string

      The formula of the field as configured in Quickbase.

    • Optional hasExtension?: boolean

      Whether this field has a phone extension.

    • Optional hours24?: boolean

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

    • Optional linkText?: string

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

    • Optional lookupReferenceFieldId?: number

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

    • Optional lookupTargetFieldId?: number

      The id of the field that is the target on the parent table for this lookup.

    • Optional maxLength?: number

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

    • Optional maxVersions?: number

      The maximum number of versions configured for a file attachment.

    • Optional numLines?: number

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

    • Optional numberFormat?: number

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

    • Optional openTargetIn?: "sameWindow" | "newWindow" | "popup"

      Indicates which target the URL should open in when a user clicks it within the product.

    • Optional parentFieldId?: number

      The id of the parent composite field, when applicable.

    • Optional seeVersions?: boolean

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

    • Optional snapFieldId?: number

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

    • Optional sortAlpha?: boolean

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

    • Optional sortAsGiven?: boolean

      Indicates if the listed entries sort as entered vs alphabetically.

    • Optional sourceFieldId?: number

      The id of the source field.

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

      The accumulation type for the summary field.

    • Optional summaryQuery?: string

      The summary query.

    • Optional summaryReferenceFieldId?: number

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

    • Optional summaryTableId?: string

      The table the summary field references fields from.

    • Optional summaryTargetFieldId?: 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).

    • Optional targetFieldId?: number

      The id of the target field.

    • Optional targetTableId?: string

      The id of the target table.

    • Optional targetTableName?: string

      The field's target table name.

    • Optional units?: string

      The units label.

    • Optional useI18NFormat?: boolean

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

    • Optional useNewWindow?: boolean

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

    • Optional versionMode?: "keepallversions" | "keeplastversions"

      Version modes for files. Keep all versions vs keep last version.

    • Optional width?: number

      The field's html input width in the product.

  • Optional required?: boolean

    Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.

  • tableId: string

    The unique identifier of the table.

  • Optional unique?: boolean

    Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.

Settings

Member Visibility

Theme