Actions199
- Collections Actions
- Forms Actions
- Actions Capabilities Actions
- Activities Actions
- Attachments Actions
- Budgets Actions
- Categories Actions
- Custom Actions Actions
- Custom Options Actions
- Documents Actions
- File Links Actions
- View File Link
- Delete File Link
- Open File Link
- Download File Link
- List Project Storages
- Get Project Storage
- Open Project Storage
- Create Storage
- Get Storage
- Update Storage
- Delete Storage
- Get Storage Files
- Prepare Storage File Upload
- Create Storage Folder
- Create Storage Oauth Credentials
- Open Storage
- Create Work Package File Link
- List Work Package File Links
- Grids Actions
- Groups Actions
- Help Texts Actions
- Memberships Actions
- Query Filter Instance Schema Actions
- News Actions
- Notifications Actions
- O Auth 2 Actions
- Posts Actions
- Principals Actions
- Priorities Actions
- Query Columns Actions
- Query Filters Actions
- Query Operators Actions
- Query Sort Bys Actions
- Relations Actions
- Previewing Actions
- Revisions Actions
- Roles Actions
- Time Entries Actions
- Time Entry Activities Actions
- Types Actions
- User Preferences Actions
- Wiki Pages Actions
- Work Schedule Actions
- Meetings Actions
- Values Property Actions
- Projects Actions
- Queries Actions
- Users Actions
- Statuses Actions
- Versions Actions
- Work Packages Actions
- Get Project Work Package Collection
- Create Project Work Package
- List Work Package File Links
- Form Create Work Package In Project
- Project Available Assignees
- List Work Packages
- Create Work Package
- Form Create Work Package
- List Work Package Schemas
- View Work Package Schema
- Delete Work Package
- View Work Package
- Update Work Package
- List Work Package Activities
- Comment Work Package
- Work Package Available Assignees
- Available Projects For Work Package
- List Available Relation Candidates
- Available Watchers
- Create Work Package File Link
- Form Edit Work Package
- Revisions
- Reminders
- List Watchers
- Add Watcher
- Remove Watcher
- Views Actions
Overview
This node interacts with the OpenProject API to list views. Views in OpenProject represent saved configurations or filters for displaying data, such as queries or reports. The "List Views" operation retrieves a collection of these views based on specified filter criteria.
Common scenarios where this node is useful include:
- Automating retrieval of project-specific or global views for reporting or dashboard generation.
- Integrating OpenProject views into other workflows or systems by fetching their definitions dynamically.
- Filtering views by type or ID to process or analyze specific subsets of data.
For example, you might use this node to fetch all global views (not assigned to any project) and then iterate over them to generate custom reports.
Properties
| Name | Meaning |
|---|---|
| Filters | JSON string specifying filter conditions to narrow down which views are returned. Supported filters include: - project: Filter views by the project their associated query belongs to. Using the operator !* returns global views.- id: Filter views by their unique identifier. - type: Filter views by their type. Example default value filters for global views: [{"project_id": {"operator": "!*", "values": null}}]. |
Output
The node outputs an array of view objects in the json field. Each object represents a view retrieved from OpenProject, containing details such as its ID, type, associated project, and other metadata defined by the OpenProject API.
If the node supports binary data output (not indicated here), it would typically represent attachments or exported files related to views, but this node primarily deals with JSON data representing views.
Dependencies
- Requires an API key credential for authenticating with the OpenProject API.
- Needs the base URL of the OpenProject instance configured in the credentials.
- Depends on the OpenProject REST API being accessible and properly configured to allow querying views.
Troubleshooting
- Invalid Filters Format: If the filters JSON is malformed or contains unsupported fields/operators, the API may return errors or no results. Ensure the filters JSON is valid and follows the documented structure.
- Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Verify that the API key and base URL are correctly set in the node credentials.
- No Views Returned: If no views match the filter criteria, the output will be empty. Adjust filters or verify that views exist in the target OpenProject instance.
- API Connectivity Issues: Network problems or incorrect URLs can prevent the node from reaching the OpenProject API. Check network connectivity and endpoint correctness.