OpenProjectInstall

Overview

This node operation creates a new grid within the OpenProject system. A grid is a structured layout defined by a specific number of rows and columns, populated with widgets that represent various data or UI elements. This operation is useful when you want to programmatically define custom grid layouts for organizing work packages or other project-related information visually.

Practical examples include:

• Automatically generating dashboards with predefined grid layouts.
• Creating custom views for project data where each widget displays different metrics or statuses.
• Setting up grids that link to other resources or actions within OpenProject.

Properties

Output

The node outputs JSON data representing the newly created grid resource as returned by the OpenProject API. This typically includes details such as the grid's ID, its dimensions (rows and columns), the configured widgets, and any associated metadata or links.

If the API supports binary data in responses (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON data structures.

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• The base URL for the OpenProject instance must be configured in the node credentials.
• The node uses the OpenProject REST API v3 endpoints to create grids and related resources.

Troubleshooting

• Invalid Widget Configuration: If widgets overlap or are incorrectly formatted, the API may reject the request. Ensure the widgets array is valid JSON and respects non-overlapping constraints.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key and base URL are correctly set.
• Invalid Row/Column Counts: Providing zero or negative numbers for row or column counts may result in errors. Use positive integers.
• Malformed JSON in Widgets or Links: Since these properties expect JSON strings parsed into objects, ensure proper JSON formatting to avoid parsing errors.

Links and References

• OpenProject API Documentation
• OpenProject Grids Concept
• n8n Documentation on Custom Nodes