OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API, enabling users to manage various OpenProject resources such as projects, users, work packages, time entries, versions, types, statuses, priorities, and categories. Specifically, the "Get By Project" operation for the "Project" resource allows retrieving all work packages associated with a specific project.

Common scenarios include:

  • Fetching detailed work package information for a given project to track tasks and progress.
  • Automating project management workflows by integrating OpenProject data into other systems.
  • Generating reports or dashboards based on project-specific work packages.

For example, a user can input a Project ID to retrieve all related work packages, which can then be processed or analyzed further in an automation workflow.

Properties

Name Meaning
Project ID The unique identifier of the project for which to retrieve associated work packages.

Output

The node outputs JSON data representing the response from the OpenProject API for the requested operation. For the "Get By Project" operation on the "Project" resource, the output JSON contains a list of work packages belonging to the specified project. Each work package includes its details as provided by the OpenProject API.

No binary data output is produced by this node.

Dependencies

  • Requires an active OpenProject instance accessible via its REST API.
  • Needs an API key credential for authentication with the OpenProject API.
  • The node uses HTTP Basic Authentication with the API key encoded in base64.
  • Requires proper configuration of the OpenProject API base URL and API key in the node credentials.

Troubleshooting

  • Invalid Project ID: If the provided Project ID does not exist or is incorrect, the API will return an error message indicating the resource was not found.
  • Authentication Errors: Missing or invalid API key credentials will cause authorization failures. Ensure the API key is correctly configured.
  • API Endpoint Issues: Network connectivity problems or incorrect base URL settings may lead to request failures.
  • Error Messages: The node surfaces error messages returned by the OpenProject API, e.g., "OpenProject error response: <message>". Review the message for details and verify input parameters and credentials.
  • Unsupported Resource or Operation: Attempting to use unsupported combinations of resource and operation will throw errors indicating the resource or method is not supported.

Links and References

Discussion