OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to list time entries. It is useful for retrieving logged work hours, filtering them by various criteria such as project, user, or date, and sorting the results. Typical use cases include generating reports on time spent on projects, monitoring ongoing timers, or extracting time entry data for further processing or integration with other tools.

For example, a project manager could use this node to fetch all time entries related to a specific project within a certain date range, sorted by the date they were spent on, to analyze team productivity.

Properties

Name Meaning
Offset Page number inside the requested collection. Used for pagination to specify which page of results to retrieve.
Page Size Number of elements to display per page. Controls how many time entries are returned in one request.
Sort By JSON string specifying sort criteria. Accepts an array of arrays where each inner array contains a field name and sort direction ("asc" or "desc"). Supported fields: id, hours, spent_on, created_at, updated_at. For example, [["spent_on", "asc"]] sorts time entries by the date they were spent on in ascending order.
Filters JSON string specifying filter conditions. Supports filtering by: work_package, project, user, ongoing (for ongoing timers), spent_on (date), created_at (creation datetime), updated_at (last update datetime), and activity. The format matches the OpenProject queries endpoint. Example: [{"work_package": {"operator": "=", "values": ["1","2"]}}, {"project": {"operator": "=", "values": ["1"]}}]

Output

The node outputs a JSON array of time entry objects matching the specified filters and sorting. Each object typically includes details such as the time entry ID, hours logged, associated project or work package, user information, dates (spent on, created at, updated at), and activity type.

No binary data output is indicated by the source code or properties.

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 time entries.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid JSON format in the Sort By or Filters properties can lead to request errors.
    • Pagination parameters (Offset and Page Size) set incorrectly may result in empty responses or incomplete data.
    • Filtering by non-existent project, user, or work package IDs will return no results.

  • Error messages:

    • Authentication errors usually indicate invalid API keys or insufficient permissions.
    • API response errors related to query parameters often mean malformed JSON or unsupported filter/sort fields.

  • Resolutions:

    • Verify API credentials and permissions.
    • Validate JSON syntax in Sort By and Filters.
    • Confirm that referenced IDs exist in the OpenProject instance.
    • Adjust pagination settings to match expected data volume.

Links and References

Discussion