OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API to manage various resources such as projects, users, work packages, time entries, versions, types, statuses, priorities, and categories. Specifically, for the Type resource with the Delete operation, it deletes a type entity identified by its ID from the OpenProject system.

Common scenarios where this node is beneficial include automating project management workflows, cleaning up unused or obsolete types in OpenProject, or integrating OpenProject data management into broader automation pipelines.

For example, if you have a list of type IDs that are no longer needed, you can use this node to delete them programmatically without manual intervention in the OpenProject UI.

Properties

Name Meaning
Type ID The ID of the type to be deleted

Output

The node outputs the JSON response returned by the OpenProject API after attempting to delete the specified type. Typically, a successful delete operation returns an empty object or confirmation message indicating the resource was removed.

The output structure is:

{
  "json": { /* API response data */ }
}

No binary data output is produced by this node.

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 methods (DELETE) to interact with the OpenProject API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Type ID: Ensure the Type ID provided exists and is correct.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or connectivity problems: Confirm that the OpenProject base URL is reachable from the n8n environment.
  • Error messages:

    • OpenProject error response: <message>: This indicates an error returned by the OpenProject API, such as "Type not found" or "Permission denied". Check the message for details and verify the input parameters and credentials.
    • The resource 'type' is not supported!: This would occur if the resource parameter is incorrect; ensure "type" is selected.
    • The method 'DELETE' is not supported!: This should not happen under normal circumstances but indicates an internal issue with HTTP method handling.

To resolve errors, double-check the Type ID, API credentials, and network access. Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion