OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows you to view a specific saved query from OpenProject and retrieve its results with various customizable parameters. It is useful when you want to programmatically access filtered, sorted, grouped, or paginated work package data based on predefined queries in OpenProject.

Common scenarios include:

  • Fetching a subset of work packages matching certain criteria for reporting or automation.
  • Overriding the default filters, sorting, grouping, or columns of a saved query dynamically.
  • Displaying timeline views or hierarchical structures of work packages.
  • Integrating OpenProject query results into other workflows or dashboards.

For example, you could use this node to get all work packages assigned to specific users, sorted by status, and grouped by priority, then process or visualize that data elsewhere.

Properties

Name Meaning
Id The unique identifier of the query to view.
Filters JSON string specifying filter conditions to override the query's saved filters. Accepts any filters supported by the work packages endpoint. Use [] for no filters.
Offset Page number within the query's result set to fetch (for pagination).
Page Size Number of items per page in the query's result set.
Columns JSON string listing selected columns to display in the table view.
Sort By JSON string specifying sort criteria to override the query's saved sort order. Example: [["status", "asc"]].
Group By Column name to group results by, overriding the query's saved grouping.
Show Sums Boolean indicating whether to sum up properties that support summation in the results.
Timestamps Comma-separated string of timestamps or relative date keywords to filter changed attributes on work packages. Supports ISO8601 dates/durations and special keywords like oneDayAgo@HH:MM+TZ. Values older than 1 day require an Enterprise Token.
Timeline Visible Boolean indicating whether to show the timeline view.
Timeline Labels JSON string to override labels shown in the timeline view.
Highlighting Mode String specifying highlighting mode in the table view, e.g., "inline".
Highlighted Attributes JSON string listing attributes to highlight when highlightingMode is inline. Empty array means all highlightable attributes are returned.
Show Hierarchies Boolean indicating whether to enable hierarchy mode in the results.

Output

The node outputs the JSON response from the OpenProject API representing the queried work packages according to the specified query and parameters. This includes detailed information about each work package such as IDs, statuses, assignees, timelines, and any other requested columns.

If timeline or hierarchy views are enabled, the output will reflect those structures accordingly.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to an OpenProject instance via an API key credential.
  • The node uses the OpenProject REST API; thus, network connectivity and valid credentials are necessary.
  • Some features (e.g., filtering by timestamps older than one day) require an Enterprise Token on the OpenProject server.

Troubleshooting

  • Invalid Query ID: If the provided query ID does not exist or is inaccessible, the node may return an error or empty results. Verify the query ID is correct and accessible by the authenticated user.
  • Malformed JSON Inputs: Filters, columns, sortBy, timelineLabels, and highlightedAttributes expect valid JSON strings. Invalid JSON will cause errors. Use proper JSON formatting.
  • Permission Issues: Insufficient permissions on the OpenProject side can lead to authorization errors. Ensure the API key has rights to view the specified query and its work packages.
  • Enterprise Token Required: Using timestamp filters older than one day without an Enterprise Token will fail. Either adjust timestamps or ensure the token is available.
  • Pagination Parameters: Incorrect offset or pageSize values might result in unexpected paging behavior or empty pages. Use sensible values within the range of the query results.

Links and References

Discussion