OpenProjectInstall

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, for the Status resource with the Update operation, it allows updating an existing status entity by its ID.

Use cases include automating updates to status entities in OpenProject workflows, such as changing the name or other attributes of a status without manual intervention. This is useful in project management automation where statuses need to be programmatically maintained or synchronized with other systems.

Example: Automatically update a status's properties when certain conditions are met in your workflow, like renaming a status or adjusting its attributes based on external triggers.

Properties

Note: The provided input properties only specify statusId as required for the update operation on the Status resource. The code does not show additional fields for updating Status, so only the ID is explicitly required here.

Output

The node outputs an array of JSON objects representing the response from the OpenProject API after performing the update operation. Each output item contains the updated status resource data as returned by the API.

• The json field includes the full details of the updated status.
• No binary data output is indicated or handled by this node.

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• The base URL and API key must be configured in the node credentials.
• Uses the Axios HTTP client library internally to make REST API calls.

Troubleshooting

• Common issues:

  • Invalid or missing Status ID will cause the API call to fail.
  • Incorrect or expired API key credential will result in authentication errors.
  • Network connectivity issues can prevent successful API communication.

• Error messages:

  • Errors returned by the OpenProject API are captured and rethrown with the message prefixed by "OpenProject error response:" followed by the API's error message.
  • If the API response lacks a detailed message, the generic error message is shown.

• Resolution tips:

  • Verify that the Status ID exists and is correct.
  • Ensure the API key credential is valid and has sufficient permissions.
  • Check network access to the OpenProject instance.
  • Enable "Continue On Fail" in the node settings to handle errors gracefully within workflows.

Links and References

• OpenProject API Documentation
• OpenProject Official Website