OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation allows you to edit an existing work package in OpenProject by submitting updated details via the API. It is useful for project managers or team members who need to update task information such as subject, description, scheduling, and related metadata programmatically within an n8n workflow.

Common scenarios include:

  • Automatically updating work package details based on external triggers or data changes.
  • Adjusting schedules or priorities of tasks without manual intervention.
  • Integrating OpenProject task updates with other tools like issue trackers, communication platforms, or custom forms.

For example, you could use this node to update the subject and due date of a work package when a related ticket status changes in another system.

Properties

Name Meaning
Id ID of the work package being modified (required).
Subject Work package subject (title or name).
Description The work package description, supporting markdown format. Should be provided as a JSON object with format, raw, and html fields.
Schedule Manually Boolean flag indicating if scheduling should be manual (true) or automatic (false).
Start Date Scheduled beginning date/time of the work package.
Due Date Scheduled end date/time of the work package.
Estimated Time Estimated time required to complete the work package excluding its descendants.
Duration Duration in hours needed to complete the work package. Must be at least one day (P1D) and will be floored to the nearest day. Has no effect unless start or due date is set. Not applicable for milestone type work packages.
Ignore Non Working Days Boolean flag indicating whether non-working days should be ignored during scheduling (true means scheduling can fall on non-working days).
Links JSON object containing references to related entities such as category, type, priority, project, status, responsible person, assignee, version, and parent work package.

Output

The node outputs the updated work package data in JSON format. This typically includes all the fields of the work package after modification, reflecting the new state as returned by the OpenProject API.

If binary data were involved (not indicated here), it would represent attachments or files related to the work package, but this operation focuses on JSON data only.

Dependencies

  • Requires an active connection to an OpenProject instance via its REST API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL of the OpenProject server must be specified in the credentials.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Invalid ID error: Ensure the Id property corresponds to an existing work package in OpenProject.
  • Authentication failures: Verify that the API key/token is valid and has sufficient permissions to edit work packages.
  • Invalid JSON in Description or Links: Make sure JSON inputs are well-formed; otherwise, parsing errors may occur.
  • Scheduling conflicts: If setting dates or duration, ensure values respect OpenProject constraints (e.g., duration minimum, milestone restrictions).
  • Network issues: Confirm connectivity to the OpenProject server and correct base URL configuration.

Links and References

Discussion