OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

The "Update Grid" operation in the Grids resource allows users to modify an existing grid's structure and content by specifying its dimensions and the widgets it contains. This node is useful when you want to programmatically adjust the layout of a grid, such as changing the number of rows or columns or updating the set of widgets displayed within the grid.

Practical examples include:

  • Dynamically resizing a dashboard grid based on user input or data changes.
  • Updating the widgets shown in a project management board or reporting interface.
  • Automating layout adjustments in response to external triggers or workflows.

Properties

Name Meaning
Row Count The number of rows the grid has.
Column Count The number of columns the grid has.
Widgets A JSON array representing the set of widgets selected for the grid. Widgets must not overlap.
Links A JSON object defining related API links or actions, e.g., scope with href and method details.

Output

The node outputs JSON data representing the updated grid object as returned by the API after the update operation. This typically includes the new grid configuration reflecting the specified row count, column count, widgets, and any other metadata provided by the service.

If the node supports binary data output (not indicated here), it would represent attachments or files related to the grid, but this node primarily deals with JSON structured data.

Dependencies

  • Requires an API key credential for authenticating requests to the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in credentials.
  • Depends on the OpenProject REST API endpoint for grids to perform the update operation.

Troubleshooting

  • Invalid widget configuration: If widgets overlap or are malformed JSON, the API may reject the request. Ensure widgets are correctly formatted and do not overlap.
  • Authentication errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key and base URL are correctly set.
  • Incorrect property types: Providing non-numeric values for row or column counts can cause validation errors. Use numbers only.
  • API endpoint issues: Network problems or incorrect URLs can lead to connection errors. Confirm the OpenProject instance URL is reachable.

Links and References

Discussion