OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows users to view details of a specific "Query Sort By" configuration in OpenProject. A "Query Sort By" defines how query results are sorted based on a column and direction (e.g., ascending or descending). This node is useful when you want to retrieve the sorting criteria applied to queries within OpenProject, for example, to audit or display current sorting settings programmatically.

Practical examples:

  • Fetching the sort order of tasks or issues in a project to replicate the same sorting in a custom dashboard.
  • Retrieving sorting preferences before exporting data to ensure consistent ordering.

Properties

Name Meaning
Id The identifier of the Query Sort By entry to view. It combines the column identifier and the sorting direction (e.g., "status-asc"). This property is required to specify which sort configuration to retrieve.

Output

The node outputs JSON data representing the details of the specified Query Sort By. This typically includes information about the column being sorted and the direction (ascending or descending). The exact structure depends on the OpenProject API response but generally contains fields like:

  • id: The unique identifier of the sort by configuration.
  • column: The column name or identifier used for sorting.
  • direction: The sorting direction, such as "asc" or "desc".

No binary data output is expected from this node.

Dependencies

  • Requires an API key credential to authenticate with the OpenProject API.
  • The node uses the OpenProject REST API endpoint configured via credentials, including the base URL.
  • Proper network access to the OpenProject instance is necessary.

Troubleshooting

  • Invalid Id error: If the provided Id does not match any existing Query Sort By, the API will return an error. Verify that the Id is correct and formatted as <column>-<direction>.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to read query sort configurations.
  • Network issues: Confirm that the OpenProject URL is reachable from n8n and no firewall blocks the request.
  • Unexpected API responses: Check if the OpenProject API version matches the node's expectations; API changes might affect the output.

Links and References

Discussion