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

Use cases include automating updates to priority attributes in your project management workflows, such as changing the name or other modifiable fields of a priority without manual intervention. For example, you might update priority details based on external triggers or synchronize priority data from another system.

Properties

Name Meaning
Priority ID The ID of the priority to update

(Note: The provided input properties only specify Priority ID as required for update operations on the Priority resource. Other updatable fields are not explicitly defined in the given snippet for Priority.)

Output

The node outputs JSON data representing the updated priority resource as returned by the OpenProject API. This typically includes all fields of the priority after the update has been applied.

No binary data output is involved.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "position": "number",
  "isDefault": "boolean",
  // ... other priority fields as per OpenProject API response
}

Dependencies

  • Requires an active connection to the OpenProject API.
  • Needs an API key credential configured in n8n for authentication.
  • The base URL of the OpenProject instance must be set in the credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.

Troubleshooting

  • Common issues:

    • Incorrect or missing Priority ID will cause the API call to fail.
    • Invalid or expired API key will result in authentication errors.
    • Network connectivity problems to the OpenProject server.
    • Attempting to update unsupported fields may cause API errors.
  • Error messages:

    • Errors from the OpenProject API are surfaced with their message, e.g., "OpenProject error response: <message>".
    • If the API returns an error message, it is included in the node error for easier debugging.
    • Generic HTTP or network errors will also be reported.
  • Resolutions:

    • Verify that the Priority ID exists and is correct.
    • Check that the API key credential is valid and has sufficient permissions.
    • Ensure the OpenProject base URL is reachable from the n8n environment.
    • Review the API documentation for allowed fields when updating priorities.

Links and References

Discussion