Actions21
- App Actions
- Table Actions
- View Actions
- Record Actions
- Field Actions
Overview
The "List All Fields" operation for the "Field" resource in this node is designed to retrieve all fields from a specified table within a Bitable app on the Lark platform. This operation is useful when you want to programmatically access metadata about the structure of a table, such as field names and types, which can then be used for data processing, integration, or automation workflows.
Practical examples include:
- Synchronizing table schema information with another system.
- Dynamically generating forms or UI elements based on the fields available in a table.
- Auditing or documenting the structure of tables in your Bitable apps.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
| App Token | The token identifying the specific Bitable app from which to list fields. |
| Table Id | The identifier of the table within the Bitable app whose fields are to be listed. |
| Options | Additional options for the request: currently supports "Use Custom Body" (boolean) to specify whether to send a custom request body. |
Output
The output JSON will contain an array of field objects representing each field in the specified table. Each field object typically includes details such as the field's ID, name, type, and other metadata describing the field's properties.
If the node supports binary data output, it would generally represent any file attachments or media associated with fields, but based on the provided code and properties, this operation primarily returns JSON metadata about fields.
Dependencies
- Requires valid authentication via either a Tenant Token or OAuth2 credentials configured in n8n.
- Needs the App Token for the target Bitable app.
- Requires the Table Id to specify which table's fields to list.
- The node communicates with the Lark Suite Open APIs at
https://open.larksuite.com/open-apis.
Troubleshooting
- Invalid App Token or Table Id: If these identifiers are incorrect or missing, the API call will fail. Ensure that the App Token and Table Id are accurate and correspond to existing resources.
- Authentication Errors: Using incorrect or expired credentials will result in authorization errors. Verify that the selected authentication method is properly configured and active.
- API Rate Limits: Excessive requests may trigger rate limiting by the Lark API. Implement retry logic or reduce request frequency if encountering such errors.
- Custom Body Usage: If "Use Custom Body" is enabled without providing a proper body, the request might fail or behave unexpectedly. Use this option only if you intend to customize the request payload.