OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API to manage work packages and other resources such as projects, users, time entries, versions, types, statuses, priorities, and categories. Specifically, for the Work Package - Delete operation, it deletes a specified work package from an OpenProject instance.

Common scenarios where this node is beneficial include automating project management workflows by programmatically removing obsolete or completed work packages, cleaning up test data, or integrating OpenProject with other systems that trigger deletions based on external events.

For example, you might use this node in an automation workflow that deletes work packages once their associated tasks are marked as done in another system, ensuring your OpenProject instance stays up-to-date without manual intervention.

Properties

Name Meaning
Project ID The unique identifier of the project to which the work package belongs. Required.
Work Package ID The unique identifier of the work package to delete. Required.

Output

The node outputs JSON data representing the response from the OpenProject API after attempting to delete the work package. Typically, a successful deletion returns an empty object or confirmation message depending on the API's behavior.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to an OpenProject instance via its REST API.
  • Needs an API key credential configured in n8n for authentication.
  • The base URL of the OpenProject instance and the API key must be provided in the node credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.

Troubleshooting

  • Common issues:

    • Invalid or missing Project ID or Work Package ID will cause the API call to fail.
    • Incorrect API key or base URL configuration will result in authentication errors.
    • Attempting to delete a non-existent work package will return an error from the API.
  • Error messages:

    • OpenProject error response: <message> indicates the API returned an error; check the message for details (e.g., "Not Found" if the work package does not exist).
    • Network or connectivity errors may occur if the OpenProject server is unreachable.
  • Resolution tips:

    • Verify that the Project ID and Work Package ID are correct and exist in OpenProject.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Confirm the base URL points to the correct OpenProject instance.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion