Actions43
- Project Actions
- User Actions
- Work Package Actions
- Time Entry Actions
- Version Actions
- Type Actions
- Status Actions
- Priority Actions
- Category Actions
Overview
This node integrates with the OpenProject API to manage various resources such as projects, users, work packages, time entries, versions, types, statuses, priorities, and categories. Specifically, the Get All operation for the Project resource retrieves a list of projects from OpenProject, supporting filtering, sorting, pagination, field selection, and grouping.
Common scenarios where this node is beneficial include:
- Fetching all projects in an organization for reporting or dashboard purposes.
- Retrieving filtered project lists based on status or other criteria.
- Exporting project data with specific fields for integration with other tools.
- Grouping projects by attributes like status to analyze project distribution.
Example use case: A project manager wants to get all active projects sorted by creation date descending, limited to 20 results, including only the project ID, name, and status fields.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of optional parameters to customize the query: |
| - Limit | Maximum number of projects to return (minimum 1). Default is 50. |
| - Offset | Number of projects to skip before starting to collect the result set (minimum 0). Default 0. |
| - Filter | Filter string to narrow down results by specific fields, e.g., status=open. |
| - Sort By | Field and direction to sort results, e.g., created_at:desc. |
| - Select Fields | Comma-separated list of project fields to include in the response, e.g., id,name,status. |
| - Group By | Field to group results by, e.g., status. |
Output
The output is an array of JSON objects representing projects retrieved from OpenProject. Each object contains the project data as returned by the OpenProject API, which can include fields such as project ID, name, status, description, and other metadata depending on the selected fields.
No binary data is output by this node.
Example output snippet:
[
{
"json": {
"id": "123",
"name": "Project Alpha",
"status": "active",
"description": "A sample project"
}
},
{
"json": {
"id": "124",
"name": "Project Beta",
"status": "archived"
}
}
]
Dependencies
- Requires an API key credential for authenticating with the OpenProject API.
- The node uses the base URL and API key from the configured credentials.
- HTTP requests are made using Axios library.
- The OpenProject instance must be accessible via the provided base URL.
Troubleshooting
- Authentication errors: If the API key or base URL is incorrect or missing, the node will fail with an authentication error. Verify that the API key credential is correctly configured.
- Invalid filter syntax: Filters must be in the format
field=value. Incorrect formats may cause no results or errors. - Unsupported resource or operation: The node throws errors if an unsupported resource or operation is specified.
- API rate limits or connectivity issues: Network problems or API rate limiting may cause request failures. Check network connectivity and OpenProject API limits.
- Error messages from OpenProject: The node surfaces error messages returned by the OpenProject API, which can help diagnose issues like invalid parameters or permissions.