Type alias QuickBaseRequestCreateField

Type declaration

• Optional addToForms?: boolean

  Whether the field you are adding should appear on forms. Defaults to false.

• Optional appearsByDefault?: boolean

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

• 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. Defaults to false.

• Optional bold?: boolean

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

• Optional fieldHelp?: string

  The configured help text shown to users within the product.

• fieldType: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file"

  The field types, click on any of the field type links for more info.

• Optional findEnabled?: boolean

  Indicates if the field is marked as searchable. Defaults to true.

• 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. Defaults to false.

• 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;
      maxLength?: number;
      maxVersions?: number;
      numLines?: number;
      numberFormat?: number;
      openTargetIn?: "sameWindow" | "newWindow" | "popup";
      parentFieldId?: number;
      seeVersions?: boolean;
      snapFieldId?: number;
      sortAlpha?: boolean;
      sortAsGiven?: boolean;
      sourceFieldId?: 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 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 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.

• tableId: string

  The unique identifier of the table.