OpenProject icon

OpenProject

Consume OpenProject API
Join our community

Actions43

Overview

This node interacts with the OpenProject API to retrieve all work packages. It is designed to fetch multiple work package records from an OpenProject instance, supporting filtering, sorting, pagination, and field selection. This operation is useful for project managers or teams who want to automate the retrieval of work package data for reporting, synchronization with other tools, or bulk processing.

Practical examples include:

  • Fetching all open work packages assigned to a team for status reporting.
  • Retrieving work packages filtered by status or priority to generate custom dashboards.
  • Exporting work package data with selected fields for integration with external systems.

Properties

Name Meaning
Options Collection of optional parameters to customize the query:
- Limit Maximum number of results to return (minimum 1).
- Offset Number of results to skip (minimum 0), useful for pagination.
- 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 specific field (e.g., status).

Output

The output is an array of JSON objects representing the retrieved work packages. Each object corresponds to a single work package record as returned by the OpenProject API. The structure depends on the fields requested but typically includes identifiers, subject, status, type, priority, assignee, dates, and other metadata.

No binary data is output by this node.

Example output snippet (simplified):

{
  "id": 123,
  "subject": "Implement feature X",
  "status": "open",
  "priority": "high",
  "assignee": {
    "id": 45,
    "name": "John Doe"
  },
  "startDate": "2024-01-01T00:00:00Z",
  "dueDate": "2024-01-15T00:00:00Z"
}

Dependencies

  • Requires an OpenProject instance accessible via its REST API.
  • Needs an API key credential configured in n8n for authentication.
  • Uses HTTP Basic Authentication with the API key encoded in the header.
  • Relies on axios library for HTTP requests.

Troubleshooting

  • Common issues:

    • Incorrect or missing API key will cause authentication failures.
    • Invalid filter or sort syntax may result in API errors.
    • Requesting too many records without pagination can lead to timeouts or large responses.
    • Using unsupported resource or operation combinations will throw errors.

  • Error messages:

    • "OpenProject error response: <message>" indicates an error returned by the OpenProject API, often due to invalid parameters or permissions.
    • "The resource 'workPackage' is not supported!" or similar means the node was configured with an unsupported resource or operation.
    • Network or connectivity errors will surface as standard HTTP request failures.

  • Resolutions:

    • Verify API key and base URL configuration.
    • Check filter and sort parameter formats.
    • Use pagination options (limit and offset) to control data volume.
    • Ensure the resource and operation are correctly set to "Work Package" and "Get All".

Links and References

Discussion