OpenProjectInstall

Overview

This node interacts with the OpenProject API, specifically allowing users to "star" a query within OpenProject. Starring a query typically marks it as a favorite or highlights it for quick access later. This is useful in scenarios where users frequently run certain queries and want to easily find them without navigating through all available queries.

For example, a project manager might star a query that shows all overdue tasks to quickly monitor project delays.

Properties

Output

The node outputs JSON data representing the result of the "star query" operation. This typically includes confirmation that the query was successfully starred or details about the updated query object. The exact structure depends on the OpenProject API response but generally confirms the action's success.

No binary data output is involved.

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• The node expects the base URL of the OpenProject instance to be configured in the credentials.
• The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

• Invalid Query ID: If the provided query ID does not exist or is incorrect, the API will likely return an error indicating the query was not found. Verify the query ID before running the node.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and base URL are correctly set in the node credentials.
• Network Issues: Connectivity problems with the OpenProject server can cause timeouts or connection errors. Check network access and server availability.
• Permission Denied: The authenticated user must have permission to star queries. Lack of permissions will result in authorization errors.

Links and References

• OpenProject API Documentation
• OpenProject Queries Guide