OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows users to view the schema of a specific Query Filter Instance within the OpenProject system. It is useful when you need to retrieve detailed metadata or structure information about a particular query filter instance by its identifier. For example, if you want to understand how a saved filter is structured or validate its configuration before applying it elsewhere, this node provides that capability.

Properties

Name Meaning
Id The unique identifier of the Query Filter Instance Schema you want to view. This corresponds to the filter's ID and is required to fetch the correct schema. Default value is "author".

Output

The node outputs JSON data representing the schema of the specified Query Filter Instance. This JSON typically includes details about the filter's fields, types, constraints, and other metadata describing how the filter is structured. There is no binary output from this node.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node depends on the OpenProject API endpoint configured via credentials, including the base URL.
  • No additional external services are needed beyond the OpenProject API.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent filter ID will likely result in an error or empty response.
    • Missing or incorrect API credentials can cause authentication failures.
    • Network connectivity issues to the OpenProject server will prevent successful requests.
  • Error messages and resolutions:

    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set up and has sufficient permissions.
    • "Not Found": Verify that the provided filter ID exists in the OpenProject instance.
    • Timeouts or network errors: Ensure the OpenProject server URL is reachable and there are no firewall restrictions.

Links and References

Discussion