OpenProjectInstall

Overview

The "List Grids" operation for the "Grids" resource retrieves a paginated list of grids from OpenProject. This node is useful when you want to fetch multiple grid configurations or views, potentially filtered by specific criteria such as associated work packages or pages.

Common scenarios include:

• Displaying available grids in a dashboard or UI.
• Automating reports or exports based on grid data.
• Filtering grids to find those related to particular projects or work packages.

For example, you might use this node to get all grids related to a specific project page and then process or display them elsewhere in your workflow.

Properties

Output

The node outputs a JSON array containing the list of grids retrieved from the API. Each item in the array represents a grid object with its details as returned by the OpenProject API.

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 credentials.
• The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

• Invalid Filters JSON: If the filters property contains malformed JSON, the API call will fail. Ensure the filters string is valid JSON matching the expected query format.
• Pagination Issues: Setting offset or page size incorrectly may result in empty responses or missing data. Verify these values correspond to actual pages available.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Confirm that the API key and base URL are correctly set in the node credentials.
• API Endpoint Changes: If the OpenProject API changes its filters or grid endpoints, the node may return errors or unexpected results. Check the OpenProject API documentation for updates.

Links and References

• OpenProject API Queries Documentation
• OpenProject Official Website