OpenProjectInstall

Overview

This node operation updates a membership in OpenProject using a form-like structure. It allows users to modify membership details such as linked resources (e.g., principal, roles, project) and metadata including notification settings. This is useful for managing user memberships programmatically, for example, updating roles or project associations of a member within an OpenProject instance.

Practical examples:

• Changing the roles assigned to a team member in a specific project.
• Updating the project association of a membership.
• Sending notifications with custom messages when membership details are updated.

Properties

Output

The node outputs JSON data representing the updated membership resource as returned by the OpenProject API. This typically includes the updated membership details reflecting changes made via the form update operation.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the OpenProject API.
• Needs the base URL of the OpenProject instance configured in credentials.
• Depends on the OpenProject REST API being accessible and supporting the membership update endpoint.

Troubleshooting

• Invalid Membership Id: If the provided membership ID does not exist, the API will likely return a 404 error. Verify the ID before running the node.
• Malformed JSON in Links or Meta: Since these properties expect JSON input, invalid JSON syntax will cause errors. Ensure proper JSON formatting.
• Insufficient Permissions: The API key used must have permissions to update memberships; otherwise, authorization errors will occur.
• Notification Issues: If sending notifications fails, check that the notification message format and content are valid and supported by the API.

Links and References

• OpenProject API Documentation
• OpenProject Memberships API Reference (for detailed info on membership update payloads)