OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to list available relation candidates for work packages within a specified project. It is useful when you want to find potential work packages that can be linked or related to a given work package, helping in managing dependencies, tracking progress, or organizing tasks more effectively.

Practical examples include:

  • Finding all work packages that could be related as predecessors or successors to a current task.
  • Filtering work packages by status or other criteria to identify relevant candidates for relations.
  • Sorting and paginating through large sets of work packages to efficiently manage project workflows.

Properties

Name Meaning
Id The project ID for which to list relation candidates (required).
Page Size Maximum number of candidates to return in one request (default is 25).
Filters JSON string specifying filter conditions to narrow down the candidate list. Accepts the same filters as the OpenProject work packages endpoint. Example: filtering by status.
Query A shortcut string to filter candidates by ID or subject text.
Type The type of relation to find candidates for, e.g., "follows", "relates" (default is "follows").
Sort By JSON string specifying sorting criteria for the results. Accepts the same sort options as the OpenProject work packages endpoint. Example: sorting by status ascending.

Output

The node outputs a JSON array of work package objects representing the available relation candidates matching the specified criteria. Each object typically includes details such as the work package ID, subject, status, and other metadata relevant to identifying and selecting relation candidates.

If binary data were involved (not indicated here), it would represent attachments or files related to work packages, but this operation focuses on JSON data only.

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 configuration.

Troubleshooting

  • Invalid Project ID: If the project ID does not exist or is incorrect, the API will return an error. Verify the project ID before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly set up.
  • Malformed Filters or Sort JSON: Filters and sort criteria must be valid JSON strings matching OpenProject API expectations. Invalid JSON will cause request errors.
  • Empty Results: If no candidates match the filters or query, the output will be empty. Adjust filters or query parameters accordingly.
  • API Rate Limits: Excessive requests may be throttled by the OpenProject server. Implement pagination and respect rate limits.

Links and References

Discussion