Apitable icon

Apitable

Interact with Apitable API

Field → Field Create

AI-generated

Overview

This node operation allows users to create a new field in a specified datasheet within a given space on the Apitable platform. It is useful for dynamically extending the structure of your datasheets by adding custom fields with various data types and attributes. Typical use cases include automating schema updates, integrating form inputs into datasheets, or programmatically managing table structures.

For example, you might use this node to add a "Due Date" field of type "Date Time" to a project management datasheet or to add a "Priority" single-select field to categorize tasks.

Properties

Name Meaning
Space Id The identifier of the workspace (space) where the datasheet resides. This must be selected from available spaces.
Datasheet Id The identifier of the specific datasheet within the chosen space where the new field will be created. Must be selected from available datasheets.
Name The name of the new field to be created. This is a string value representing the field's label.
Type The data type of the field. Options include: Single Text, Text, Single Select, Multi Select, Number, Currency, Percent, Date Time, Attachment, Member, Checkbox, Rating, URL, Phone, Email, Work Doc, One Way Link, Two Way Link, Magic Look Up, Formula, Auto Number, Created Time, Last Modified Time, Created By, Last Modified By, Button.
Property A JSON object defining additional attributes specific to the chosen field type. Different field types support different attributes; these should be provided according to the field type's requirements.

Output

The node outputs JSON data representing the newly created field object as returned by the Apitable API. This typically includes details such as the field ID, name, type, and any configured attributes. The output can be used downstream to reference the new field or confirm its creation.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Apitable API via an API key credential.
  • The node depends on the user having access to the specified space and datasheet.
  • The node uses dynamic loading methods to populate options for spaces and datasheets, which require proper API permissions.

Troubleshooting

  • Invalid Space or Datasheet ID: If the selected space or datasheet does not exist or the API key lacks permission, the node will fail. Verify that the API key has access rights and that the IDs are correct.
  • Malformed Property JSON: The Property field expects valid JSON. Invalid JSON syntax will cause parsing errors. Ensure the JSON is well-formed.
  • Unsupported Field Type Attributes: Providing attributes in Property that do not match the selected field type may result in API errors. Consult the Apitable documentation for correct attribute formats per field type.
  • API Rate Limits or Connectivity Issues: Network problems or API rate limits may cause failures. Check network connectivity and API usage quotas.

Links and References

Discussion