OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to retrieve the schema for project queries. Specifically, it allows users to view the structure or schema of queries associated with a given project in OpenProject. This can be useful for understanding what data fields and filters are available within project queries, enabling further automation or reporting based on those queries.

Practical examples include:

  • Fetching the query schema to dynamically build user interfaces that allow filtering or sorting project data.
  • Automating reports by understanding which fields can be queried for a specific project.
  • Integrating OpenProject data into other systems by first retrieving the query schema to map data correctly.

Properties

Name Meaning
Id The numeric identifier of the project whose query schema you want to view. This is required to specify which project's query schema to retrieve.

Output

The node outputs JSON data representing the schema of the queries for the specified project. This JSON typically includes details about available fields, their types, possible filters, and other metadata describing how queries can be constructed for that project.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating 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 and an OpenAPI specification (openapi.json) bundled with the node for request building.

Troubleshooting

  • Common issues:

    • Invalid or missing project ID: Ensure the "Id" property is set to a valid existing project number.
    • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Network or URL misconfiguration: Confirm the base URL in credentials points to a reachable OpenProject instance.

  • Error messages:

    • Unauthorized or 401 errors usually indicate invalid or missing API credentials.
    • 404 errors may mean the project ID does not exist or the endpoint path is incorrect.
    • Timeout or network errors suggest connectivity issues or incorrect base URL.

Resolving these generally involves checking input parameters, credentials, and network settings.

Links and References

Discussion