TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node allows updating a single "View Field" object in the connected system via an API. It is useful when you want to modify properties of a specific view field, such as its visibility, size, position, or aggregation operation, without affecting other fields.

Common scenarios include:

  • Changing the display settings of a field in a user interface dynamically.
  • Adjusting aggregation operations for reporting or data summarization purposes.
  • Reordering fields within a view by updating their position.
  • Toggling the visibility of certain fields based on user preferences or workflow conditions.

For example, you might use this node to update a field's size and make it invisible in a dashboard view, or to change the aggregate operation from SUM to AVG for a numeric field.

Properties

Name Meaning
Id The unique identifier of the View Field object to update.
Depth Determines how much related nested data to include in the response: 0 (only primary object), 1 (primary plus directly related objects), or 2 (primary, directly related, and their related objects).
Is Visible Boolean flag indicating whether the View Field should be visible or hidden.
Size Numeric value specifying the size of the View Field (e.g., width or length depending on UI context).
Field Metadata Id Identifier of the target field metadata that this View Field corresponds to.
View Id Identifier of the parent View to which this View Field belongs.
Position Numeric position index of the View Field within the View, used for ordering fields.
Aggregate Operation Optional aggregation function applied to the field's data. Options include: AVG, COUNT, MAX, MIN, SUM, COUNT EMPTY, COUNT NOT EMPTY, COUNT UNIQUE VALUES, PERCENTAGE EMPTY, PERCENTAGE NOT EMPTY, COUNT TRUE, COUNT FALSE.

Output

The node outputs JSON data representing the updated View Field object. The structure includes all the updated properties and may also contain nested related objects depending on the Depth parameter.

If binary data were involved (not indicated here), it would typically represent files or media associated with the View Field, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential to authenticate requests to the Twenty API.
  • The base URL for API requests is configured via credentials.
  • Uses the Twenty API version 1.0.3 OpenAPI specification for request construction.

Troubleshooting

  • Invalid Id: If the provided Id does not correspond to an existing View Field, the API will likely return a "Not Found" error. Verify the Id before running the node.
  • Permission Errors: Insufficient permissions or invalid API credentials can cause authorization failures. Ensure the API key has rights to update view fields.
  • Invalid Property Values: Providing out-of-range values for properties like size or unsupported strings for aggregateOperation may result in validation errors. Use the provided options and valid types.
  • Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures. Check network access and credential domain settings.

Links and References

Discussion