OpenProject icon

OpenProject

Consume OpenProject API

Overview

This node integrates with the OpenProject API to manage project-related data. Specifically, the "Update" operation for the "Project" resource allows users to modify existing projects by changing their name, description, and status. This is useful in scenarios where project details evolve over time, such as updating a project's progress status or refining its description.

Practical examples:

  • Updating a project's name after a rebranding.
  • Changing the status of a project from "Active" to "Archived" when it is completed.
  • Adding or modifying the description to provide more context about the project.

Properties

Name Meaning
Project ID The unique identifier of the project to update (required).
Project Name The new name for the project (required).
Additional Fields Optional fields to update:
- Description: Text describing the project.
- Status: One of "Active", "Archived", or "On Track".

Output

The node outputs JSON data representing the updated project object as returned by the OpenProject API. This includes all project details after the update has been applied.

No binary data output is produced 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 axios library for making HTTP requests.

Troubleshooting

  • Common issues:

    • Invalid or missing Project ID will cause the API call to fail.
    • Incorrect API key or base URL configuration will result in authentication errors.
    • Providing invalid values for status or other fields may cause validation errors from the API.
  • Error messages:

    • Errors returned by the OpenProject API are surfaced with the message prefix "OpenProject error response:" followed by the API's error message.
    • Network or unexpected errors will show the raw error message.
  • Resolution tips:

    • Verify that the Project ID exists and is correct.
    • Ensure the API key and base URL are correctly set in the node credentials.
    • Check that the status value is one of the allowed options ("active", "archived", "on_track").
    • Use the "Continue On Fail" option if you want the workflow to proceed despite individual item errors.

Links and References

Discussion