OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to list placeholder users within the "Principals" resource. Placeholder users are typically used in project management tools like OpenProject to represent users who do not have a full user account but still need to be referenced, for example, as task assignees or group members.

Common scenarios where this node is beneficial include:

  • Retrieving a filtered list of placeholder users based on specific criteria such as name, group membership, or status.
  • Integrating OpenProject placeholder user data into workflows for reporting, notifications, or synchronization with other systems.
  • Automating user management tasks by fetching placeholder users that match certain filters.

Practical example:

  • You want to get all placeholder users whose names contain "Darth" and belong to a particular group, then use this data to assign tasks dynamically in your project workflow.

Properties

Name Meaning
Filters JSON string specifying filter conditions to narrow down the list of placeholder users. Supports filtering by name (partial match), group (group membership), and status. Example: [{"name": {"operator": "~", "values": ["Darth"]}}].
Select Comma-separated list of properties to include in the response. Common values include total, elements/name, elements/self, and self. This controls which fields are returned for each placeholder user.

Output

The node outputs JSON data representing the list of placeholder users matching the specified filters and selected properties. The structure includes:

  • total: The total number of placeholder users matching the query.
  • elements: An array of placeholder user objects, each containing the requested fields such as name and self (a reference URL).
  • self: A URL referencing the current query result.

No binary data output is produced by this node.

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.
  • The node uses standard HTTP headers to accept and send JSON content.

Troubleshooting

  • Invalid Filter Format: If the Filters property contains malformed JSON or unsupported filter keys, the API may return errors. Ensure the JSON is valid and only supported filters (name, group, status) are used.
  • 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: If no placeholder users match the filters, the elements array will be empty. Adjust filter criteria if unexpected.
  • API Rate Limits or Connectivity Issues: Network problems or API rate limits can cause request failures. Check connectivity and API usage policies.

Links and References

Discussion