Actions43
- Project Actions
- User Actions
- Work Package Actions
- Time Entry Actions
- Version Actions
- Type Actions
- Status Actions
- Priority Actions
- Category Actions
Overview
This node interacts with the OpenProject API to retrieve all categories available in an OpenProject instance. It is designed to fetch multiple category records with flexible options for filtering, sorting, pagination, and grouping. This operation is useful when you want to list or analyze categories used in your project management workflows within OpenProject.
Common scenarios:
- Fetching a list of all categories to display in a dashboard or report.
- Retrieving categories filtered by specific criteria (e.g., only active categories).
- Exporting categories data for integration with other tools.
- Grouping categories by a field to understand distribution or status.
Example use case:
You want to get up to 100 categories starting from the 10th record, sorted by creation date descending, and only include the fields id, name, and status in the response. You can set these options accordingly to tailor the output.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of optional parameters to customize the retrieval of categories: |
| - Limit | Max number of results to return (minimum 1). |
| - Offset | Number of results to skip before starting to collect the result set (minimum 0). |
| - Filter | Filter results by specific fields using a simple field=value syntax (e.g., status=open). |
| - Sort By | Sort results by a field and direction, e.g., created_at:desc. |
| - Select Fields | Comma-separated list of fields to include in the response, e.g., id,name,status. |
| - Group By | Group results by a specified field, e.g., status. |
Output
The node outputs an array of JSON objects representing the categories retrieved from OpenProject. Each object corresponds to a category resource and contains fields as returned by the OpenProject API, potentially filtered by the Select Fields option.
The structure typically includes fields such as:
id: Unique identifier of the category.name: Name of the category.- Other metadata fields depending on the API response and selected fields.
No binary data is output by this node.
Dependencies
- Requires an API key credential for authenticating with the OpenProject API.
- The node uses the base URL and API key provided in the credentials to make HTTP requests.
- The OpenProject instance must be accessible via the provided base URL.
Troubleshooting
- Invalid Resource or Operation: If the resource or operation is not supported, the node throws an error indicating unsupported resource or operation.
- Authentication Errors: If the API key is invalid or missing, the node will fail with an authentication error. Ensure the API key credential is correctly configured.
- Filter Syntax: Filters must be in the format
field=value. Incorrect filter syntax may cause no results or errors. - API Rate Limits or Connectivity Issues: Network problems or API rate limits may cause request failures. Check connectivity and API usage limits.
- Error Messages from OpenProject: If the API returns an error message, it will be included in the node error output for easier diagnosis.
To resolve errors, verify credentials, input parameters, and network access to the OpenProject API.
Links and References
- OpenProject API Documentation
- OpenProject Categories API Reference (for detailed fields and filters)