OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node allows you to create a new work package within a specified project in OpenProject, a project management system. Work packages represent tasks, milestones, or other units of work that can be tracked and managed.

Common scenarios for this node include:

  • Automating task creation when a new project phase starts.
  • Integrating with other tools to generate work packages based on external triggers.
  • Creating milestones or deliverables programmatically as part of a workflow.

For example, you could use this node to automatically create a set of predefined tasks (work packages) whenever a new project is initiated, ensuring consistent project setup without manual input.

Properties

Name Meaning
Id (project id) The numeric identifier of the project where the work package will be created.
Notify Boolean flag indicating whether change notifications (e.g., email alerts) should be sent to all users interested in changes to the work package (watchers, author, assignee).
Id (work package id) Numeric identifier of the work package (usually 0 or omitted when creating a new one).
Lock Version Number used for optimistic locking to prevent conflicting updates.
Subject The title or subject of the work package. This is a required string describing the work package briefly.
Type The type of the work package. Currently only "Work Package" is supported.
Description A JSON object containing the description of the work package, supporting markdown formatting.
Schedule Manually Boolean indicating if scheduling is manual (true) or automatic (false).
Readonly Boolean indicating if the work package is readonly except for status changes.
Start Date Scheduled start date of the work package (string format).
Due Date Scheduled end date of the work package (string format).
Date Date on which a milestone is achieved (string format).
Derived Start Date Computed start date deduced from descendant work packages; may differ from Start Date if manual scheduling is active.
Derived Due Date Computed due date deduced from descendant work packages; may differ from Due Date if manual scheduling is active.
Duration (Not implemented) Intended to specify the amount of time in hours needed to complete the work package. Not applicable for milestones.
Estimated Time Estimated time required to complete the work package excluding descendants.
Derived Estimated Time Estimated time including descendants.
Ignore Non Working Days (Not implemented) Whether scheduling ignores non-working days.
Spent Time Time already booked by users working on this work package. Requires permission to view time entries.
Percentage Done Numeric value representing the completion percentage of the work package.
Derived Percentage Done Completion percentage derived from the work package and its descendants.
Created At Timestamp of creation; writable only by admins with special permissions.
Updated At Timestamp of the most recent update to the work package.
Links (_links) JSON object defining various API links related to the work package such as adding comments, attachments, relations, watchers, etc. Required for API interaction.

Output

The node outputs JSON data representing the newly created work package as returned by the OpenProject API. This includes all properties of the work package such as its ID, subject, description, dates, status, and related metadata.

If the API supports it, binary data output is not indicated for this operation, so the output is purely JSON structured data.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL of the OpenProject instance must be configured in the node credentials.
  • The node uses standard HTTP headers for JSON content negotiation.
  • Permissions: The user associated with the API key must have rights to create work packages in the specified project.

Troubleshooting

  • Authentication errors: Ensure the API key and base URL are correctly configured and valid.
  • Permission denied: The API user must have sufficient permissions to create work packages in the target project.
  • Invalid input data: Required fields like subject and id (project id) must be provided and valid.
  • Malformed JSON in description or _links: The description and _links fields expect valid JSON; invalid JSON will cause request failures.
  • Optimistic locking conflicts: If lockVersion is used incorrectly, updates may fail due to version mismatches.
  • Unimplemented features warnings: Some properties like duration and ignoreNonWorkingDays are marked as not implemented and may be ignored by the API.

Links and References

Discussion