OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows you to create a new "View" in the OpenProject system via its API. A "View" typically represents a saved query or filter configuration that users can reuse to quickly access specific subsets of data within OpenProject. This node is useful when automating project management workflows, such as programmatically setting up custom views for different teams or reporting purposes.

For example, you might use this node to:

  • Automatically create a view that filters tasks by priority or status.
  • Set up personalized dashboards for team members based on their roles.
  • Generate views that aggregate issues related to specific milestones or sprints.

Properties

Name Meaning
Id The unique identifier for the view you want to create.
Links JSON object representing additional query parameters or links associated with the view.

The Links property expects a JSON structure, which by default contains an empty query object. This allows you to specify complex nested parameters that define how the view behaves or what it links to.

Output

The node outputs JSON data representing the newly created view as returned by the OpenProject API. This typically includes details such as the view's ID, configuration, and any metadata provided by the server.

If the API supports binary data for views (not indicated here), the node would handle it accordingly, but based on the code and properties, the output is purely JSON.

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 depends on the OpenProject REST API being accessible and properly configured to accept view creation requests.

Troubleshooting

  • Invalid or missing Id: Since the Id property is required, ensure it is provided and unique. Duplicate IDs may cause errors.
  • Malformed JSON in Links: The Links property expects valid JSON. Invalid JSON syntax will cause parsing errors.
  • Authentication errors: Verify that the API key credential is correct and has sufficient permissions to create views.
  • API endpoint unreachable: Check network connectivity and the correctness of the base URL.
  • Unexpected API responses: Inspect the raw response for error messages from OpenProject, which may indicate permission issues or invalid request formats.

Links and References

Discussion