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.
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:
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"
}
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
Read
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
Read
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.
Write
Read
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.
Write
Read
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
Read
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
Read
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
Read
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
Read
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
Read
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.
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
Read
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
Read
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
Read
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
Read
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.
2023-10-01", "2023-10-01T12:00:00.000Z")
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
Read
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
Read
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.
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.
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.
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.
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
Read
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.
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.
