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, the Work Package - Get By Project operation retrieves all work packages associated with a specified project.

Typical use cases include:

  • Fetching all tasks or work items related to a particular project for reporting or tracking.
  • Automating workflows that require processing or analyzing work packages within a project.
  • Integrating OpenProject data into other systems by extracting work package details per project.

For example, you might use this node to get all work packages of a project before updating their status or exporting them to an external dashboard.

Properties

Name Meaning
Project ID The unique identifier of the project whose work packages you want to retrieve.

Additional optional parameters (available under "Options") can be used to refine the results but are not required for this operation.

Output

The node outputs an array of JSON objects, each representing a work package belonging to the specified project. The structure corresponds directly to the OpenProject API response for work packages, typically including fields like:

  • id: Work package identifier
  • subject: Title or subject of the work package
  • description: Detailed description (if available)
  • status, priority, assignee, startDate, dueDate, etc., depending on the work package data

No binary data is output by this operation.

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.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.
  • Relies on the OpenProject REST API v3 endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Project ID will cause the API call to fail.
    • Incorrect API key or base URL configuration leads to authentication errors.
    • Network connectivity problems may prevent reaching the OpenProject server.
  • Error messages:

    • Errors returned from OpenProject API are surfaced with messages like:
      OpenProject error response: <message>
      This usually indicates an issue such as invalid parameters or permission problems.
    • Generic errors from HTTP requests or misconfiguration will show the underlying message.
  • Resolution tips:

    • Verify the Project ID exists and is accessible with your API key.
    • Check that the API key and base URL are correctly set in the node credentials.
    • Ensure network access to the OpenProject server.
    • Use the node's "Continue On Fail" option to handle errors gracefully during batch operations.

Links and References

Discussion