OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation, List Relations, interacts with the OpenProject API to retrieve a list of relations between work packages. Relations represent links or dependencies from one work package to another within OpenProject projects. This operation is useful for project managers and teams who want to analyze or visualize how different tasks or work packages are connected.

Typical use cases include:

  • Fetching all relations where a specific work package is involved.
  • Filtering relations by type (e.g., "follows", "blocks") to understand task dependencies.
  • Sorting relations to display them in a meaningful order.

For example, you might use this node to get all relations where work package ID 42 is the source, helping you identify all tasks that depend on it.

Properties

Name Meaning
Filters A JSON string specifying filter conditions to narrow down which relations to list. It supports filtering by relation ID, source work package (from), target work package (to), any involved work package (involved), or relation type (e.g., "follows"). Example: [{"from": {"operator": "=", "values": 42}}].
Sort By A JSON string specifying sorting criteria for the results. It accepts the same format as OpenProject query endpoints. For example, [["type", "asc"]] sorts relations by their type in ascending order.

Output

The node outputs an array of relation objects in the json field of each item. Each relation object typically includes details such as:

  • Relation ID
  • Source work package ID (from)
  • Target work package ID (to)
  • Relation type (e.g., "follows", "blocks")
  • Other metadata related to the relation

This structured output allows further processing or integration into workflows, such as reporting or visualization.

The node does not output binary data.

Dependencies

  • Requires an active connection to an OpenProject instance via its REST API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL of the OpenProject server must be provided in the credentials.

Troubleshooting

  • Invalid Filter or Sort JSON: If the JSON strings provided in Filters or Sort By are malformed, the API request will fail. Ensure valid JSON syntax.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify the API key/token and base URL.
  • No Relations Found: If filters are too restrictive or no relations exist matching criteria, the output will be empty.
  • API Endpoint Changes: If OpenProject updates their API, some fields or filter options may change. Check the official OpenProject API documentation if unexpected errors occur.

Links and References

Discussion