OpenProjectInstall

Overview

This node integrates with the OpenProject API to manage work packages and other related resources such as projects, users, time entries, versions, types, statuses, priorities, and categories. Specifically for the Work Package - Get operation, it retrieves detailed information about a specific work package by its ID.

Common scenarios where this node is beneficial include:

• Fetching detailed data of a particular work package within a project for reporting or automation.
• Integrating OpenProject work package details into other systems or workflows.
• Automating status checks or updates based on work package information.

Practical example:

• You want to retrieve the current status, assignee, and due date of a work package to trigger notifications or update dashboards automatically.

Properties

Output

The node outputs an array of JSON objects, each representing the response from the OpenProject API for the requested work package. The JSON structure corresponds directly to the OpenProject work package resource, including fields such as subject, description, status, priority, assignee, start date, due date, estimated time, percentage done, version, category, and any other metadata provided by the API.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "id": "123",
  "subject": "Implement feature X",
  "description": "Detailed description of the work package",
  "status": {
    "name": "In Progress"
  },
  "assignee": {
    "name": "John Doe"
  },
  "startDate": "2024-01-01",
  "dueDate": "2024-01-15",
  "percentageDone": 50,
  ...
}

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 or Work Package ID parameters will cause the API call to fail.
  • Incorrect API key or base URL configuration will result in authentication errors.
  • Network connectivity issues can prevent successful API requests.

• Error messages:

  • OpenProject error response: <message> indicates an error returned by the OpenProject API, often due to invalid IDs or permissions.
  • Generic errors may indicate network problems or misconfiguration.

• Resolutions:

  • Verify that the Project ID and Work Package ID are correct and exist in OpenProject.
  • Ensure the API key credential is valid and has sufficient permissions.
  • Check the base URL is correctly set to your OpenProject instance.
  • Confirm network access to the OpenProject server.

Links and References

• OpenProject API Documentation
• OpenProject Work Packages API Reference