OpenProject icon

OpenProject

Consume OpenProject API
Join our community

Actions43

Overview

This node integrates with the OpenProject API to manage work packages, which are units of work or tasks within projects. Specifically, the Create Work Package operation allows users to create a new work package in a specified project with defined attributes such as subject, type, and optional additional details.

Common scenarios for this node include:

  • Automating task creation in project management workflows.
  • Integrating OpenProject task creation with other tools (e.g., form submissions, issue trackers).
  • Bulk creating work packages based on external data sources.

For example, you could use this node to automatically create a work package when a customer support ticket is received, assigning it to the relevant project and setting priority or due dates.

Properties

Name Meaning
Subject The title or subject of the work package; a required string describing the task.
Project ID The identifier of the project to which the work package belongs; required to associate it.
Type ID The identifier of the type/category of the work package; required to classify the task.
Additional Fields Optional extra fields to provide more details about the work package. Includes:
- Description A detailed description of the work package.
- Status ID Identifier for the current status of the work package (e.g., open, closed).
- Priority ID Identifier for the priority level of the work package.
- Assignee ID Identifier of the user assigned to the work package.
- Start Date The planned start date/time of the work package.
- Due Date The planned due date/time of the work package.
- Estimated Time Estimated time to complete the work package, formatted as an ISO 8601 duration (e.g., PT1H30M).
- Percentage Done Completion percentage of the work package (0 to 100).
- Version ID Identifier of the version associated with the work package.
- Category ID Identifier of the category under which the work package falls.

Output

The node outputs JSON data representing the created work package as returned by the OpenProject API. This typically includes all properties of the newly created work package such as its unique ID, subject, project association, type, status, and any additional fields set during creation.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node expects the base URL of the OpenProject instance and the API key to be configured in the credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.
  • Relies on the OpenProject REST API v3 endpoints.

Troubleshooting

  • Authentication errors: If the API key or base URL is incorrect or missing, the node will fail with authentication errors. Verify that the API key credential is correctly set up.
  • Invalid IDs: Providing invalid or non-existent projectId, typeId, or other referenced IDs will cause API errors. Ensure these IDs exist in your OpenProject instance.
  • Missing required fields: The node requires subject, projectId, and typeId for creating a work package. Omitting these will result in validation errors.
  • API error messages: Errors from the OpenProject API are surfaced with their message content. For example, if a field value is invalid, the API response message will help identify the issue.
  • Network issues: Connectivity problems to the OpenProject server will cause request failures. Check network access and firewall settings.

Links and References

Discussion