OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node interacts with the OpenProject API to list queries based on specified filter conditions. It is useful for retrieving saved query configurations from OpenProject, which can represent customized views or reports of project data. Typical use cases include automating the retrieval of project-specific queries for reporting, monitoring updates to queries, or integrating query data into other workflows.

For example, a user might want to fetch all global queries (not assigned to any specific project) or retrieve queries updated after a certain date to synchronize with an external dashboard.

Properties

Name Meaning
Filters A JSON string specifying filter conditions to narrow down the list of queries returned. Supported filters include:
- project: Filters queries by their assigned project. Using the operator !* returns global queries.
- id: Filters queries by their unique identifier.
- updated_at: Filters queries based on their last update timestamp.

Output

The node outputs a JSON array of query objects matching the specified filters. Each object represents a query in OpenProject and typically includes details such as the query's ID, name, associated project, and metadata like the last update time.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL of the OpenProject instance must be configured in the node credentials.
  • The node depends on the OpenProject REST API being accessible and properly configured to allow query listing.

Troubleshooting

  • Invalid Filter JSON: If the Filters property contains malformed JSON, the node will fail to send the request. Ensure the JSON syntax is correct.
  • Authentication Errors: If the API key or base URL is incorrect or missing, authentication will fail. Verify that the API credentials are valid and have sufficient permissions.
  • Unsupported Filters: Using unsupported filter keys or operators may result in empty results or API errors. Use only the documented filters (project, id, updated_at) with supported operators.
  • Network Issues: Connectivity problems to the OpenProject server will cause request failures. Check network access and firewall settings.

Links and References

Discussion