Lark Sheets icon

Lark Sheets

Lark Sheets Management

Overview

This node, named "Lark Sheets," provides management capabilities for Lark Sheets documents within the n8n workflow automation platform. Specifically, the "Update Filter Conditions" operation under the "Filter Condition Filter View" resource allows users to modify filter conditions applied to a filter view in a spreadsheet sheet. This is useful when you want to programmatically adjust how data is filtered in a sheet, such as updating criteria to show only rows matching certain values or conditions.

Practical examples include:

  • Automatically updating filter conditions based on external triggers or data changes.
  • Customizing views for different users or scenarios by changing filter parameters dynamically.
  • Integrating with other systems to maintain consistent data filtering rules across platforms.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Spreadsheet Token The unique token identifying the target spreadsheet document.
Sheet Id Identifier of the specific sheet within the spreadsheet where the filter view exists.
Filter View Id Identifier of the filter view whose filter conditions are to be updated.
Condition Id Column letter designation indicating which column's filter condition to update.
Compare Type The comparison operator/type used in the filter condition (e.g., equals, contains).
Expected A collection of expected values/items that the filter condition will match against.
Filter Type The type/category of the filter being applied (e.g., text filter, number filter).
Custom Body JSON object allowing the user to specify a fully custom request body instead of using individual fields.
Options > Use Custom Body Boolean flag to indicate whether to send the custom JSON body instead of the standard properties.

Output

The node outputs JSON data representing the response from the Lark Sheets API after updating the filter conditions. This typically includes confirmation of the update and details about the new filter condition state. The output does not explicitly handle binary data.

Dependencies

  • Requires an active connection to Lark Suite APIs.
  • Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
  • Network access to https://open.larksuite.com/open-apis is necessary.

Troubleshooting

  • Authentication errors: Ensure that the correct authentication method is selected and valid credentials are provided.
  • Invalid IDs: Errors may occur if the Spreadsheet Token, Sheet Id, Filter View Id, or Condition Id are incorrect or do not exist.
  • Malformed custom body: If using the custom JSON body option, ensure the JSON is well-formed and matches the expected schema.
  • API rate limits or network issues: May cause failures; verify connectivity and API usage quotas.

Links and References

Discussion