OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to retrieve aggregated results from collections, specifically supporting aggregation on the work package collection. It allows users to group data by a specified column and optionally show sums for numeric fields within those groups. This is useful for project management scenarios where you want to analyze work packages by status, priority, or other attributes, providing summarized insights such as counts or totals per group.

Practical examples:

  • Grouping work packages by their status to see how many are open, in progress, or closed.
  • Aggregating work packages by assigned user to understand workload distribution.
  • Summarizing estimated hours or costs grouped by project phase.

Properties

Name Meaning
Group By The column name to group the aggregation by. Can be any column returned by the OpenProject queries endpoint (e.g., "status").
Show Sums Boolean flag indicating whether to include sum totals in the aggregation result. Defaults to true.

Output

The node outputs JSON data representing the aggregated results of the collection query. The structure typically includes groups keyed by the specified "Group By" column, each containing aggregated metrics such as counts and sums (if enabled). The exact shape depends on the OpenProject API response but generally provides a summary view of the grouped data.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in the credentials.
  • Relies on the OpenProject REST API, particularly the queries endpoint that supports aggregation.

Troubleshooting

  • Invalid Group By Column: If the specified "Group By" column does not exist or is misspelled, the API may return an error or empty results. Verify the column name against the OpenProject queries endpoint documentation.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access the work package collection and perform aggregation queries.
  • API Endpoint Issues: Confirm the base URL is correct and the OpenProject server is reachable.
  • Show Sums Flag Misuse: If sums are requested on non-numeric columns, the API might ignore them or return unexpected results.

Links and References

Discussion