OpenProjectInstall

Overview

This node operation creates a file link associated with a specific work package in the OpenProject system. It is useful when you want to programmatically attach or reference files related to a particular work package, enabling better organization and traceability of project documents.

Practical examples include:

• Automatically linking generated reports or logs to a work package after a build or deployment process.
• Attaching design documents or specifications to a task for easy access by team members.
• Creating references to external files stored elsewhere but linked within the project management context.

Properties

Output

The node outputs JSON data representing the result of the file link creation operation. This typically includes details about the newly created file link such as its ID, URL, and metadata confirming the association with the specified work package.

If the node supports binary data output (not evident from the provided code), it would represent the actual file content or attachment; however, based on the static analysis, the output focuses on JSON metadata.

Dependencies

• Requires an API key credential to authenticate with the OpenProject API.
• Needs the base URL of the OpenProject instance configured in the node credentials.
• Depends on the OpenProject REST API being accessible and properly configured to allow file link creation on work packages.

Troubleshooting

• Invalid Work Package ID: If the provided work package ID does not exist or is incorrect, the API will likely return an error. Verify that the ID corresponds to an existing work package.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and base URL are correctly set in the node credentials.
• Permission Issues: The authenticated user must have sufficient permissions to create file links on the specified work package.
• Network or API Availability: Connectivity issues or API downtime can cause request failures. Check network connectivity and OpenProject service status.

Common error messages might include "Not Found" for invalid IDs, "Unauthorized" for credential problems, or "Forbidden" for permission issues.

Links and References

• OpenProject API Documentation
• OpenProject Work Packages Guide
• n8n Documentation on Credentials