OpenProjectInstall

Overview

This node interacts with the OpenProject API to list users based on specified criteria. It is useful for retrieving user information from an OpenProject instance, such as when you want to automate user management, generate reports, or synchronize user data with other systems.

Typical use cases include:

• Fetching a paginated list of users filtered by status, group membership, or name.
• Sorting users by specific attributes like status.
• Selecting only certain user properties to optimize data transfer and processing.

For example, you might use this node to get all invited users in a particular group or to find users whose names or emails match a search string.

Properties

Output

The node outputs JSON data representing the list of users retrieved from OpenProject. The structure typically includes:

• total: Total number of users matching the query.
• elements: An array of user objects, each containing the selected properties such as name and self-reference URLs.
• Additional metadata depending on the select parameter.

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 the node credentials.
• Depends on the OpenProject REST API being accessible and properly configured to accept the queries.

Troubleshooting

• Common issues:

  • Incorrect or missing API credentials will cause authentication failures.
  • Malformed JSON in the Filters or Sort By properties can lead to request errors.
  • Requesting too large a page size may result in timeouts or performance issues.
  • Filtering or sorting by unsupported fields will cause the API to reject the request.

• Error messages:

  • Authentication errors usually indicate invalid or expired API tokens; verify and update credentials.
  • JSON parsing errors suggest that the Filters or Sort By inputs are not valid JSON strings; ensure correct formatting.
  • HTTP 400 or 422 errors often mean invalid query parameters; check filter and sort criteria against OpenProject API documentation.

Links and References

• OpenProject API Queries Endpoint Documentation
• OpenProject User Management
• OpenProject Official Website