OpenProjectInstall

Overview

This node interacts with the OpenProject API to retrieve details about a specific revision. The "View Revision" operation under the "Revisions" resource allows users to fetch information about a particular revision by its unique identifier. This is useful in scenarios where you want to track changes, audit modifications, or display version history of project artifacts managed within OpenProject.

Practical examples include:

• Fetching metadata about a document revision to show who made changes and when.
• Integrating revision details into custom reports or dashboards.
• Automating notifications or workflows based on revision updates.

Properties

Output

The node outputs JSON data representing the detailed information of the specified revision. This typically includes fields such as revision id, author, timestamp, comments, and any other metadata provided by the OpenProject API for that revision.

If the node supports binary data output (not indicated here), it would represent associated files or attachments related to the revision, but this is not evident from the provided code snippet.

Dependencies

• Requires an API key credential for authenticating requests to the OpenProject API.
• Needs the base URL of the OpenProject instance configured in the credentials.
• Depends on the @devlikeapro/n8n-openapi-node package for handling OpenAPI-based requests.
• Uses an OpenAPI specification (openapi.json) bundled with the node to define available operations and properties.

Troubleshooting

• Common issues:

  • Invalid or missing revision ID will cause the API call to fail.
  • Incorrect or expired API credentials will result in authentication errors.
  • Network connectivity problems can prevent reaching the OpenProject server.
  • Misconfigured base URL may lead to request failures.

• Error messages:

  • "Revision not found" indicates the specified revision ID does not exist.
  • "Unauthorized" or "Authentication failed" suggests invalid API credentials.
  • "Network error" or "Could not connect to server" points to connectivity issues.

• Resolutions:

  • Verify the revision ID is correct and exists in the OpenProject system.
  • Ensure API credentials are valid and have sufficient permissions.
  • Check network settings and OpenProject server availability.
  • Confirm the base URL in credentials matches the OpenProject instance URL.

Links and References

• OpenProject API Documentation
• OpenProject Official Website
• n8n Documentation on Creating Nodes