OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to list versions of projects. It allows users to retrieve filtered and sorted lists of version entities from an OpenProject server. This is useful for project managers or developers who want to programmatically access version information, such as release versions or milestones, to integrate with other tools or automate reporting.

Practical examples include:

  • Fetching all system-shared versions sorted by name descending.
  • Filtering versions based on sharing scope (e.g., only those shared within a project hierarchy).
  • Integrating version data into dashboards or CI/CD pipelines.

Properties

Name Meaning
Filters JSON string specifying filter conditions for listing versions. Accepts the same format as returned by the OpenProject queries endpoint. Supported filters include sharing, which filters versions by how they are shared within the server. Possible values: none, descendants, hierarchy, tree, system. Example default: [{"sharing": {"operator": "*", "values": ["system"]}}]
Sort By JSON string specifying sort criteria for the returned versions. Accepts the same format as returned by the OpenProject queries endpoint. Supported attributes: id (version id), name (version name using numeric collation). Deprecated attribute: semver_name (use name instead). Default example: [["name", "desc"]]

Output

The node outputs a JSON array of version objects retrieved from the OpenProject API according to the specified filters and sorting. Each object represents a version entity with its associated properties as defined by the OpenProject API.

If the API supports binary data related to versions (not indicated here), it would be included in the binary output; however, this node primarily deals with JSON data representing version metadata.

Dependencies

  • Requires an active connection to an OpenProject server via its REST API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The node uses standard HTTP headers for JSON content negotiation (Accept: application/json).

Troubleshooting

  • Invalid Filter or Sort JSON: If the JSON strings provided in Filters or Sort By are malformed or contain unsupported attributes, the API may return errors or empty results. Validate JSON syntax and ensure only supported filter keys and sort attributes are used.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key/token is correctly set up in the node credentials.
  • No Versions Returned: If filters are too restrictive or do not match any versions, the output will be empty. Try broadening filter criteria.
  • API Endpoint Issues: Ensure the base URL for the OpenProject server is correct and accessible from n8n.

Links and References

Discussion