OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation allows you to create a new Work Package in OpenProject, a project management system. Work Packages represent tasks, milestones, or other units of work within a project. Creating a Work Package programmatically is useful for automating project tracking, task creation, and integration with other systems such as issue trackers or time management tools.

Typical use cases include:

  • Automatically creating tasks when new issues are reported in an external system.
  • Generating milestones or deliverables based on external triggers.
  • Integrating project planning workflows by syncing data from other tools into OpenProject.

For example, you could use this node to create a new task with a subject, description, start and due dates, and assign it to a user, all triggered by an event in another application.

Properties

Name Meaning
Notify Boolean flag indicating whether change notifications (e.g., email) should be sent to all users interested in the work package changes (watchers, author, assignee).
Id Numeric identifier of the work package.
Lock Version Number used for optimistic locking to prevent conflicting updates.
Subject Required. The title or subject of the work package.
Type Type of the work package. Only option available is "Work Package".
Description JSON object describing the work package content, supporting markdown format. Example: { "format": "markdown", "raw": "I am formatted!", "html": "I am formatted!" }.
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 date).
Due Date Scheduled end date of the work package (string date).
Date Date milestone is achieved (string date).
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 represent 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 (string).
Derived Estimated Time Estimated time including descendants (string).
Ignore Non Working Days Not implemented. Whether to ignore non-working days when scheduling.
Spent Time Time already booked against this work package by users (string). Requires permission to view time entries.
Percentage Done Numeric percentage representing completion of the work package.
Derived Percentage Done Numeric percentage representing completion including descendant work packages.
Created At Timestamp of creation. Writable only by admins with special settings enabled.
Updated At Timestamp of last update to the work package.
Links Required. JSON object containing various API links related to the work package, such as addComment, addRelation, attachments, author, assignee, project, status, etc. This is used internally to manage relations and actions.

Output

The node outputs the created Work Package data as JSON. This includes all properties set during creation plus any additional metadata returned by the OpenProject API, such as unique identifiers, timestamps, and relational links.

If the API supports binary data related to work packages (e.g., attachments), those would be handled separately, but this operation focuses on JSON data representing the work package entity.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL of the OpenProject instance must be configured in the credentials.
  • The node uses JSON-based REST API calls to interact with OpenProject.
  • Proper permissions are required in OpenProject to create work packages and optionally to set readonly fields or view time entries.

Troubleshooting

  • Permission errors: If the API returns authorization errors, verify that the API key has sufficient rights to create work packages and modify the specified fields.
  • Validation errors: Missing required fields like subject or malformed JSON in description or _links can cause request failures. Ensure all required fields are provided and JSON is valid.
  • Optimistic locking conflicts: If lockVersion is used incorrectly, updates may fail. Usually, this is more relevant for updates rather than creation.
  • Notification issues: Setting notify to true sends emails to watchers and assignees; ensure email settings in OpenProject are correctly configured.
  • Date formatting: Dates should be in a proper string format accepted by OpenProject (usually ISO 8601). Incorrect formats may cause errors.

Links and References

Discussion