OpenProjectInstall

Overview

This node interacts with the OpenProject API to list file links associated with a specific work package. It is useful when you want to retrieve all files linked to a particular work package in an OpenProject instance, for example, to display or process attachments related to project tasks.

A practical use case includes automating the retrieval of documents or media files attached to a work package for reporting or integration with other systems.

Properties

Example filter usage:

[
  {
    "storage": {
      "operator": "=",
      "values": ["42"]
    }
  }
]

Output

The node outputs a JSON array containing the file links associated with the specified work package. Each item in the output typically represents a file link object with metadata such as file name, URL, storage information, and other relevant attributes as provided by the OpenProject API.

No binary data output is indicated by the source code.

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• Needs the base URL of the OpenProject instance configured in the node credentials.
• The node uses the OpenProject REST API endpoints to fetch data.

Troubleshooting

• Invalid Work Package ID: If the provided work package ID does not exist, the API will likely return an error or empty result. Verify the ID before running the node.
• Malformed Filters JSON: The filters property must be a valid JSON string matching the expected format. Invalid JSON will cause request failures.
• Authentication Errors: Ensure that the API key and base URL are correctly set in the credentials; otherwise, authentication errors will occur.
• API Rate Limits or Connectivity Issues: Network problems or API rate limits may cause request failures. Check connectivity and API usage quotas.

Links and References

• OpenProject API Documentation - Queries Endpoint
• OpenProject Official Website