OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to list memberships within an OpenProject instance. It allows users to retrieve membership data filtered and sorted according to various criteria such as principal name, group, project, role, status, and timestamps of creation or update.

Common scenarios where this node is beneficial include:

  • Automating reports on project team compositions.
  • Filtering memberships to identify blocked or active members.
  • Sorting memberships by creation date or principal attributes for auditing purposes.
  • Integrating membership data into other workflows or systems for further processing.

For example, a project manager could use this node to automatically fetch all active memberships in a specific project, sorted by the member's name, to generate a current team list.

Properties

Name Meaning
Filters JSON string specifying filter conditions to narrow down the memberships returned. Supported filters include: any_name_attribute (searches all name variants, email, login), blocked (filter by temporary block status), group (filter by group memberships), name (filter by principal name), principal (filter by principal ID), project (filter by project ID), role (filter by role ID), status (filter by principal status), created_at (filter by membership creation time), updated_at (filter by last update time).
Sort By JSON string specifying sort criteria for the results. Supported sort fields are: id (primary key), name (principal name), email (principal email; non-email principals sorted last), status (principal status; groups and principals without status sorted with active users), created_at (membership creation datetime), updated_at (last update time). The default sorting is ascending by id.

Output

The node outputs a JSON array of membership objects matching the specified filters and sorted accordingly. Each membership object typically contains details about the membership itself, including references to the principal (user or group), project, roles assigned, status, and timestamps for creation and updates.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The OpenProject instance URL must be configured in the node credentials.
  • The node depends on the OpenProject REST API endpoints for queries and memberships.

Troubleshooting

  • Invalid Filter or Sort JSON: If the JSON provided in Filters or Sort By properties is malformed, the API request will fail. Ensure valid JSON syntax and correct filter/sort keys as per OpenProject API documentation.
  • Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Verify that the API key and base URL are correctly set in the node credentials.
  • Empty Results: Applying overly restrictive filters may result in no memberships returned. Try broadening filter criteria or removing filters to verify data availability.
  • API Rate Limits or Connectivity Issues: Network problems or API rate limits can cause request failures. Check network connectivity and API usage policies.

Links and References

Discussion