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 operation retrieves a collection of work packages associated with a specific project from OpenProject. It is useful for project managers, team members, or automation workflows that need to fetch and process multiple work packages within a project, such as generating reports, tracking progress, or integrating project data into other systems.
Practical examples include:
- Fetching all open tasks (work packages) in a project to display in a dashboard.
- Retrieving filtered work packages based on status or type for automated notifications.
- Grouping and sorting work packages to analyze workload distribution.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier of the project whose work packages are to be retrieved. |
| Offset | The page number inside the requested collection, used for pagination. |
| Page Size | Number of work packages to display per page, controlling the size of each paginated response. |
| Filters | JSON string specifying filter conditions to apply on the work packages. Accepts the same format as returned by the OpenProject queries endpoint. For no filters, send an empty array ([]). |
| Sort By | JSON string specifying sort criteria for the work packages. Accepts the same format as returned by the OpenProject queries endpoint. |
| Group By | The column name by which to group the work packages, e.g., "status". |
| Show Sums | Boolean indicating whether properties that support summation should be summed up in the response. |
| Select | Comma-separated list of properties to include in the response, e.g., total,elements/subject,elements/id,self. |
Output
The output contains a JSON object representing the collection of work packages retrieved from the specified project. This includes metadata about the collection (such as pagination info) and the actual work package elements with their selected properties.
If binary data were involved (not indicated here), it would typically represent attachments or files related to work packages, but this operation focuses on JSON data only.
Dependencies
- Requires an API key credential for authenticating with the OpenProject API.
- Needs the base URL of the OpenProject instance configured in the node credentials.
- Depends on the OpenProject REST API being accessible and properly configured to allow querying work packages.
Troubleshooting
Common issues:
- Invalid project ID leading to empty or error responses.
- Incorrectly formatted JSON strings in Filters or Sort By causing request failures.
- Pagination parameters (Offset, Page Size) set out of range resulting in no data.
- Insufficient permissions or invalid API credentials causing authentication errors.
Error messages and resolutions:
- 401 Unauthorized: Check that the API key credential is valid and has access rights.
- 400 Bad Request: Verify that JSON inputs for filters and sorting are correctly formatted.
- 404 Not Found: Confirm the project ID exists and is accessible.
- 500 Internal Server Error: May indicate server-side issues; retry later or contact OpenProject support.