OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows you to create an attachment for a specific work package in OpenProject. It is useful when you want to programmatically add files or documents related to a work package, such as specifications, images, or reports, directly from your workflow automation.

A practical example would be automatically attaching a generated PDF report to a work package whenever a certain event occurs, like the completion of a task or receipt of an email.

Properties

Name Meaning
Id The numeric ID of the work package that will receive the attachment. This identifies the target work package within OpenProject where the attachment should be added.

Output

The node outputs JSON data representing the result of the attachment creation operation. This typically includes details about the newly created attachment such as its ID, filename, and metadata confirming successful upload.

If binary data (the actual file content) is involved, it would represent the attachment being sent to OpenProject, but the output mainly confirms the attachment's creation status and related information.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in the credentials.
  • Depends on the OpenProject REST API endpoint for managing work package attachments.

Troubleshooting

  • Common issues:

    • Invalid or missing work package ID can cause errors; ensure the ID corresponds to an existing work package.
    • Authentication failures if the API key or URL is incorrect or expired.
    • File size or type restrictions imposed by OpenProject may prevent attachment uploads.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check API credentials and permissions.
    • "Work package not found": Verify the provided work package ID exists.
    • "Attachment upload failed": Confirm the file meets OpenProject’s requirements and the request payload is correctly formed.

Links and References

Discussion