OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node operation allows you to add a watcher to a specific work package in OpenProject. Watchers are users who receive notifications about changes or updates to the work package, making it easier to keep relevant team members informed. This is useful in project management scenarios where tracking progress or changes on tasks (work packages) is critical.

For example, if a project manager wants to ensure that a developer or stakeholder stays updated on a particular task, they can use this operation to add that user as a watcher to the work package.

Properties

Name Meaning
Id The unique identifier of the work package to which you want to add a watcher. Must be a number.
User A JSON object representing the user to add as a watcher. This should contain the necessary user information formatted as JSON.

Output

The node outputs JSON data representing the result of the API call to add a watcher to the specified work package. This typically includes confirmation details such as the updated work package information or the watcher addition status.

If the node supports binary data output, it would generally relate to any file attachments or media associated with the work package, but this operation primarily deals with JSON data.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node depends on the OpenProject REST API being accessible and properly configured.
  • The base URL for the OpenProject instance must be set in the node credentials.
  • The node uses JSON-formatted user data to specify the watcher.

Troubleshooting

  • Invalid Work Package ID: If the provided work package ID does not exist, the API will return an error. Verify the ID is correct.
  • Malformed User JSON: The user property must be valid JSON. Errors parsing this input will cause the request to fail.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to modify watchers.
  • Network Issues: Connectivity problems with the OpenProject server will prevent the operation from completing.
  • Permission Denied: The authenticated user may lack rights to add watchers; check user roles and permissions in OpenProject.

Links and References

Discussion