OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node interacts with the OpenProject API to list query filter instance schemas associated with a specific project. It is useful when you want to retrieve metadata about available query filters for a given project, which can help in dynamically building queries or understanding what filters are applicable within that project's context.

A practical example would be automating the retrieval of all query filter schemas for a project to display them in a custom UI or to use them as part of a workflow that builds complex queries based on user input.

Properties

Name Meaning
Id The unique numeric identifier of the project for which to list the query filter instance schemas. This property is required.

Output

The node outputs JSON data representing the list of query filter instance schemas for the specified project. Each item in the output typically contains details about a query filter schema such as its fields, types, and constraints, allowing downstream nodes or workflows to understand how to construct valid queries for that project.

No binary data output is indicated.

Dependencies

  • Requires an API key credential to authenticate with the OpenProject API.
  • The base URL for the OpenProject instance must be configured in the node credentials.
  • The node depends on the @devlikeapro/n8n-openapi-node package for handling OpenAPI-based requests.

Troubleshooting

  • Common issues:

    • Invalid or missing project ID will result in errors or empty results.
    • Incorrect or expired API credentials will cause authentication failures.
    • Network connectivity issues to the OpenProject server may prevent successful API calls.
  • Error messages:

    • Authentication errors typically indicate invalid API keys or misconfigured credentials.
    • "Project not found" or similar errors suggest the provided project ID does not exist or is inaccessible.
  • Resolutions:

    • Verify the project ID is correct and accessible by the authenticated user.
    • Ensure API credentials are valid and have sufficient permissions.
    • Check network connectivity and the correctness of the OpenProject base URL.

Links and References

Discussion