OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation retrieves a list of file links associated with a specific work package in OpenProject. It is useful when you want to programmatically access or manage files attached to a particular work package, for example, to display them in a dashboard, synchronize files with another system, or automate reporting.

Practical examples:

  • Fetching all document links related to a project task to include in a project status report.
  • Automatically downloading or backing up files attached to a work package.
  • Filtering and listing files based on storage location or other criteria.

Properties

Name Meaning
Id The unique identifier of the work package whose file links you want to list.
Filters JSON string specifying filter conditions for the file links. Supports filters like storage. Accepts the same format as OpenProject's queries endpoint. Example: [{"storage":{"operator":"=","values":["42"]}}]

Output

The output contains a JSON array of file link objects related to the specified work package. Each object typically includes metadata about the file link such as URL, filename, storage details, and possibly other attributes depending on the API response.

If binary data is returned (e.g., actual file content), it would be represented in the binary output field, but this operation primarily lists links rather than file contents.

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 depends on the OpenProject REST API being accessible and the user having permission to read work package attachments.

Troubleshooting

  • Invalid Work Package ID: If the provided work package ID does not exist or is inaccessible, the node will likely return an error indicating "Not Found" or "Unauthorized". Verify the ID and permissions.
  • Malformed Filters JSON: Providing invalid JSON in the Filters property can cause request failures. Ensure the JSON syntax is correct and matches the expected query format.
  • API Authentication Errors: Missing or incorrect API credentials will result in authentication errors. Confirm that the API key and base URL are correctly set.
  • No File Links Returned: If no files are linked to the work package or filters exclude all files, the output will be empty. Double-check the filters and work package contents.

Links and References

Discussion