OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to manage work packages, specifically allowing the removal of a watcher from a given work package. Removing a watcher means that the specified user will no longer receive notifications or updates related to that work package.

Common scenarios where this node is useful include:

  • Automating project management workflows by dynamically updating watchers based on task assignments.
  • Cleaning up watchers when users are no longer involved in a particular work package.
  • Integrating with other systems to synchronize user notifications and permissions.

For example, if a user is reassigned from a task, this node can be used to remove them as a watcher automatically, ensuring they do not get irrelevant notifications.

Properties

Name Meaning
Id The unique identifier of the work package from which a watcher should be removed. Must be a number.
User Id The unique identifier of the user to be removed as a watcher from the specified work package. Must be a number.

Output

The node outputs JSON data representing the result of the watcher removal operation. This typically includes confirmation of success or details about the updated work package watcher list. The exact structure depends on the OpenProject API response but generally confirms whether the watcher was successfully removed.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to the OpenProject API.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the OpenProject instance must be provided in the credentials configuration.

Troubleshooting

  • Invalid Work Package ID or User ID: If either ID does not exist or is incorrect, the API may return an error indicating the resource was not found. Verify IDs before running the node.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly set up.
  • Permission Issues: The authenticated user must have sufficient permissions to modify watchers on the specified work package.
  • Network or API Downtime: Connectivity issues or OpenProject service outages will prevent successful execution.

Common error messages might include "Not Found", "Unauthorized", or "Forbidden". Resolving these involves checking IDs, credentials, and user permissions.

Links and References

Discussion