Bika
GuideDeveloper

Field Cell Value

Field Cell Value

This document details all field types and their corresponding data formats, helping developers clarify data processing specifications in different scenarios when using OpenAPI for field operations.

Field Models

For cell values of different field types, some fields will present different data formats when read and edited, which are specifically divided into the following two scenarios:

  • read: Refers to the data format of the field cell when the interface response is returned, i.e., the presentation form of the field when data is obtained from the interface.
  • write: Refers to the data format that must be followed when editing field cells, i.e., the standard format when submitting data to the interface to modify field values.

Cell Value Write Errors

When writing values to field cells, if the data format does not meet the requirements, the interface will return a format error prompt.

For example, writing a string to a number field:

{
  "fields": {
    "number_field": "example text"
  }
}

You will receive the following error response:

{
  "success": false,
  "code": 4031,
  "message": "The input value of field number_field is invalid: example text"
}

Field Types

Single Line Text

The single - line text field is suitable for storing short text information that does not require line breaks, such as names, titles, labels, etc. This field does not support symbols like line breaks and indents, and the input content will be restricted to display in the same line to ensure the conciseness and standardization of text display.

  • Write
    • type: string
    • example: "example text"
  • Read
    • cellFormat: json
      • type: string
      • example: "example text"
    • cellFormat: string
      • type: string
      • example: "example text"

Multi Line Text

The multi - line text field is mainly used to store longer text content that requires line breaks, such as remarks, descriptions, detailed explanations, etc. It supports line breaks through line break characters, meeting the input and display needs of long text and making the text structure clearer and easier to read.

  • Write
    • type: string
    • example: "This is a paragraph \n of multi - line text" (supports line breaks represented by line break characters)
  • Read
    • cellFormat: json
      • type: string
      • example: "This is a paragraph \n of multi - line text"
    • cellFormat: string
      • type: string
      • example: " This is a paragraph of multi - line text " (line breaks are presented with <br> tags)

Url

The URL field is specially used to store various network links, such as web addresses, resource links, etc. It can identify and process the input URL, and display it in a standardized form when read, facilitating users to access directly and improving the convenience of link usage.

Email

The email field is used to store email addresses and is applicable to scenarios such as contact and notification. It can ensure that the input content conforms to the email format specifications, facilitating the system to perform email verification and related operations such as sending emails.

Phone

The phone field is used to record phone number information and supports phone number formats of different countries and regions. When read, the number will be formatted to make it more readable, and it is also convenient for related operations such as dialing.

  • Write
    • type: string
    • example: "+8613800138000"
  • Read
    • cellFormat: json
      • type: string
      • example: "+8613800138000"
    • cellFormat: string
      • type: string
      • example: "+8613800138000"

Number

The number field is mainly used to store various numerical information, such as quantity, amount, age, etc. It only supports the input of number types to ensure the accuracy and consistency of numerical values, facilitating numerical calculation, statistical analysis and other operations.

  • Write
    • type: number
    • example: 123.45
  • Read
    • cellFormat: json
      • type: number
      • example: 123.45
    • cellFormat: string
      • type: string
      • example: "123.4500"

Currency

The currency field is used to handle currency - related values and is suitable for recording information such as prices and expenses. It can not only store the amount value but also be associated with the corresponding currency type. When displayed, it will be formatted according to the currency type to clearly present currency information.

  • Write
    • type: number
    • example: 199.99
  • Read
    • cellFormat: json
      • type: number
      • example: 199.99
    • cellFormat: string
      • type: string
      • example: "$199.99"

Percent

The percent field is used to represent proportional relationships, such as completion rate, growth rate, etc. It is written in decimal form and converted to percentage form for display when read, making the proportion information more intuitive and easy to understand, and facilitating proportion - related analysis and comparison.

  • Write
    • type: number
    • example: 75.33
  • Read
    • cellFormat: json
      • type: number
      • example: 75.33
    • cellFormat: string
      • type: string
      • example: "75.33%"

Rating

The rating field is used to evaluate the level of things, such as product satisfaction, service quality, etc. It represents the rating value through integers, intuitively reflecting the level of evaluation, and facilitating the statistics and analysis of evaluation results.

  • Write
    • type: number (integer, representing the rating value)
    • example: 4
  • Read
    • cellFormat: json
      • type: number
      • example: 4
    • cellFormat: string
      • type: string
      • example: "4"

AutoNumber

The auto - number field is used to generate a unique auto - incrementing number for each record, such as order number, asset number, etc. It is automatically generated by the system and does not support manual writing, ensuring the uniqueness and continuity of the number, and facilitating the identification and management of records.

  • Write: read_only, not supported for writing
  • Read
    • cellFormat: json
      • type: number
      • example: 2
    • cellFormat: string
      • type: string
      • example: "2"

CheckBox

The check box field is used to represent binary states, such as "Yes / No", "Completed / Uncompleted", etc. It represents the checked or unchecked state through boolean values, which is simple and intuitive to operate, and is applicable to scenarios that require binary judgment.

  • Write
    • type: boolean
    • example: true (checked), false (unchecked)
  • Read
    • cellFormat: json
      • type: boolean
      • example: true
    • cellFormat: string
      • type: string
      • example: "true", "false"

Single Select

The single - select field provides a set of preset options, and users can only select one of them. It is applicable to scenarios where a unique answer is selected from a fixed range, such as gender, education background, etc. It ensures the uniqueness of the selection, and the options are clear and clear, facilitating data statistics and analysis.

  • Write
    • type: string (unique identifier or name of the option)
    • example: "In Progress"
  • Read
    • cellFormat: json
      • type: string
      • example: "In Progress"
    • cellFormat: string
      • type: string
      • example: "In Progress"

Multi Select

Similar to the single - select field, the multi - select field allows users to select multiple options from preset options. It is applicable to scenarios where multiple answers need to be selected, such as hobbies, skill tags, etc. It meets the needs of multi - dimensional selection and facilitates the management and analysis of multiple options.

  • Write
    • type: array of string
    • example: ["Friday", "SatDay"]
  • Read
    • cellFormat: json
      • type: array of string
      • example: ["Friday", "SatDay"]
    • cellFormat: string
      • type: string
      • example: "Friday, SatDay"

Member

The member field is used to associate users in the system, such as task leaders, project participants, etc. It is associated through the member ID, and displays relevant member information when read, facilitating the management and collaboration of members.

  • Write
    • type: array of contact unit object
    • example: ['member_id']
  • Read
    • cellFormat: json
      • type: array of object
        • object:
          • id: string
          • type: 'Member' | 'Team' | 'Role'
          • name: string
      • example: [{"id": "mem123", "type": "Member", "name": "John Doe"}]
    • cellFormat: string
      • type: string
      • example: "John Doe"

Date Time

The date - time field is used to record specific dates and times, such as event occurrence time, deadline, etc. It is stored in ISO 8601 format, accurate to seconds, facilitating time sorting, filtering, calculation and other operations.

  • Write
    • type: string (ISO 8601 Format, eg: "

2023-10-01", "2023-10-01T12:00:00.000Z")

  • example: "2023-10-01T12:00:00Z"
  • Read
    • cellFormat: json
      • type: string
      • example: "2023-10-01T12:00:00Z"
    • cellFormat: string
      • type: string
      • example: "2023-10-01 20:00:00" (displayed in local time format)

Date Range

The date range field is used to record a time period, consisting of a start date and an end date, such as event holding time, vacation time, etc. It clearly indicates the start and end range of time, facilitating the comparison and analysis of time periods.

  • Write
    • type: string (format: start/end)
      • properties:
        • start: string (start date, ISO 8601 format)
        • end: string (end date, ISO 8601 format)
    • example: "2021-03-29T10:05:00.000Z/2021-04-05T10:05:00.000Z"
  • Read
    • cellFormat: json
      • type: string
      • example: "2021-03-29 -> 2021-04-05"
    • cellFormat: string
      • type: string
      • example: "2021-03-29 -> 2021-04-05"

Attachment

The attachment field is used to store various files, such as documents, pictures, audio, etc. It supports uploading multiple files, records information such as file name, size, and access address, facilitating the management and viewing of files and meeting the diverse needs of data storage.

  • Write
    • type: array
      • items: object
        • properties:
          • id: attachment id
          • name: optional (attachment name)
    • example: [{"id": "attach123"}, {id: "attach456"}]
  • Read
    • cellFormat: json
      • type: array
        • items: object
          • properties:
            • id: string (attachment ID)
            • name: string
            • mimeType: string
            • size: number (attachment size, in bytes)
            • url: string (access URL of the attachment)
            • thumbnailUrl: string
      • example: [{"id": "att1", "name": "file1.pdf", "url": "[https://example.com/file1.pdf](https://example.com/file1.pdf)", "size": 102400}]
    • cellFormat: string

Created Time

The created time field is used to record the creation time of the record, which is automatically generated by the system and does not support manual modification. It accurately reflects the generation time of the record, facilitating the management and tracking of records in the time dimension, such as sorting and filtering by creation time.

  • Write: read_only, not supported for writing
  • Read
    • cellFormat: json
      • type: string (ISO 8601 format)
      • example: "2023-09-01T08:00:00Z"
    • cellFormat: string
      • type: string
      • example: "2023-09-01 16:00:00" (displayed in local time format)

Modified Time

The modified time field is used to record the last modification time of the record. Whenever the record content changes, this field will be automatically updated. It reflects the latest changes of the record, facilitating the tracking of the modification history and version changes of the record.

  • Write: read_only, not supported for writing
  • Read
    • cellFormat: json
      • type: string (ISO 8601 format)
      • example: "2023-09-02T09:30:00Z"
    • cellFormat: string
      • type: string
      • example: "2023-09-02 17:30:00" (displayed in local time format)

Created By

The created by field is used to record the user who created the record, which is automatically associated by the system and does not support manual modification. It clarifies the creator of the record, facilitating the tracing of the source and responsibility of the record, which is of great significance in collaborative scenarios.

  • Write: read_only, not supported for writing
  • Read
    • cellFormat: json
      • type: object
        • properties:
          • id: string (member id)
          • name: string (member name)
      • example: {"id": "mem456", "name": "John Doe"}
    • cellFormat: string
      • type: string
      • example: "John Doe"

Modified By

The modified by field is used to record the user who last modified the record. Whenever the record is modified, this field will be automatically updated to the modifier's information. It tracks the person responsible for modifying the record, facilitating tracing and communication when problems occur.

  • Write: read_only, not supported for writing
  • Read
    • cellFormat: json
      • type: object
        • properties:
          • id: string (member id)
          • name: string (member name)
      • example: {"id": "mem456", "name": "John Doe"}
    • cellFormat: string
      • type: string
      • example: "John Doe"

The link field is used to associate other records, such as associated order records, customer records, etc. It is associated through the ID of the target record, enabling quick jump to the associated record, facilitating the associated query and management of data.

  • Write
    • type: string of array (record id of table)
    • example: ["record123", "record456"]
  • Read
    • cellFormat: json
      • type: string of array
      • example: ["record123", "record456"]
    • cellFormat: string
      • type: string
      • example: "record123, record456"

Lookup

The lookup field is used to obtain and display the value of a specified field from other associated data tables, such as looking up the industry a customer belongs to from the customer table and displaying it in the order table. It is automatically calculated and generated by the associated field and does not support direct writing, ensuring data consistency and accuracy.

  • Write: read_only, automatically calculated by associated fields, not supported for direct writing
  • Read
    • cellFormat: json
      • type: field type cell value
    • cellFormat: string
      • type: array of any from field cell value
      • example: ["example text", "another text"]

Formula

The formula field automatically calculates and displays results through a preset calculation formula, such as calculating the total price based on quantity and unit price, calculating the duration based on start time and end time, etc. The calculation formula is set by the user, and the field value is automatically updated with changes in related fields, and manual writing is not supported.

  • Write: read_only
  • Read
    • type: string | number | boolean | array of (strings | numbers)
    • example: '5'
Recommend AI Automation Templates
Community Reporter
Community Reporter generates AI-powered community reports and activity reports, providing clear community insights, analytics, and highlights. Track interactions, monitor trends, and get actionable community analysis quickly and efficiently.
ADDIE Instructional Design Model
ADDIE Instructional Design Model
Use the ADDIE Instructional Design Model as a practical instructional design template to manage your entire course development process. Plan and track e‑learning content development, instructor‑led training design, and training materials development for professional skills courses and employee training programs. This template helps instructional designers, training developers, and education project managers organize tasks, align learning objectives, and streamline course creation for any organization.
Automated Birthday Email Celebration
Automated Birthday Email Celebration
Automate birthday email automation with the Automated Birthday Email Celebration template. Send personalized, automated birthday emails using a flexible birthday email template and automated email template that work with your customer data integration. Use this email scheduling tool to set automated email reminders and schedule birthday marketing emails at the perfect time. Boost customer retention emails and loyalty with B2B email automation and an email personalization tool that delivers timely, relevant birthday email campaigns without manual work.
Automated Currency Data Retrieval (Python)
Automated Currency Data Retrieval (Python)
The Automated Currency Data Retrieval (Python) template runs a scheduled job to fetch specific currency rates every day and store them in a structured table, building clean historical exchange rate data over time. Use it for financial data automation that powers dashboards, alerts, and automated financial reporting, so finance teams, forex traders, accountants, and risk managers always have up-to-date FX data at hand. By automating data collection, you save time, reduce manual errors, and make better investment and risk decisions based on reliable exchange rate history.
AI Auto-Tweet with Image
Automate your X (Twitter) content with the AI Auto-Tweet with Image template. Use it as a Twitter post scheduler and Twitter automation tool that reads tweet content from your database, generates tweets with AI, uploads images, and auto-posts to X. Batch pre-write tweets, update their status to Publish, and let the workflow handle tweet scheduling, posting, and link tracking—perfect for social media managers, creators, and brands who want consistent Twitter activity without manual posting.
Automated Stock Data Retrieval (JavaScript)
Automated Stock Data Retrieval (JavaScript)
The Automated Stock Data Retrieval (JavaScript) template automatically fetches US stock data every day and writes it into a structured table, giving you clean, consistent time series for analysis. Use it as part of your financial data automation stack to power stock trend analysis, dashboards, alerts, and quantitative analysis data for models and backtests. Designed for financial analysts, investment managers, data scientists, quants, and portfolio managers, it saves time on manual data collection so you can focus on research, strategy, and better investment decisions.

APITable Compatible API

Previous Page

Filter Query Language

Next Page

On this page

Field Cell ValueField ModelsCell Value Write ErrorsField TypesSingle Line TextMulti Line TextUrlEmailPhoneNumberCurrencyPercentRatingAutoNumberCheckBoxSingle SelectMulti SelectMemberDate TimeDate RangeAttachmentCreated TimeModified TimeCreated ByModified ByLinkLookupFormula