OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node interacts with the OpenProject API to retrieve information about a specific group. The "Get Group" operation fetches details of a group by its unique identifier. This is useful in scenarios where you need to access group metadata, such as group name, members, or permissions, within an automation workflow.

Practical examples include:

  • Automating user management by retrieving group details before adding or removing users.
  • Synchronizing group data between OpenProject and other systems.
  • Generating reports that include group information.

Properties

Name Meaning
Id The unique numeric identifier of the group to retrieve. This is required to specify which group’s details should be fetched.

Output

The output JSON contains the detailed information of the requested group as returned by the OpenProject API. This typically includes fields such as group id, name, description, members, and other metadata related to the group.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to 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 and Content-Type: application/json).

Troubleshooting

  • Common issues:

    • Invalid or missing group ID will result in errors or empty responses.
    • Incorrect API credentials or base URL configuration can cause authentication failures.
    • Network connectivity issues may prevent successful API calls.
  • Error messages:

    • "Group not found" — Verify that the provided group ID exists in your OpenProject instance.
    • "Authentication failed" — Check that the API key and base URL are correctly set in the node credentials.
    • "Request timeout" — Ensure network connectivity and that the OpenProject server is reachable.

Links and References

Discussion