OpenProject icon

OpenProject

Consume OpenProject API
Join our community

Actions43

Overview

This node interacts with the OpenProject API to retrieve all versions of projects. It is designed to fetch multiple version records with flexible options for filtering, sorting, pagination, and grouping. This operation is useful when you want to list or analyze all versions available in your OpenProject instance, such as generating reports on project milestones or tracking version statuses.

Practical examples:

  • Retrieve the first 50 versions sorted by creation date descending.
  • Filter versions by status (e.g., only open versions).
  • Group versions by a specific field like status to see distribution.

Properties

Name Meaning
Options Collection of optional parameters to customize the query:
- Limit Max 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 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 versions from OpenProject. Each object corresponds to one version resource and contains fields as returned by the OpenProject API, potentially filtered by the "Select Fields" option.

No binary data is output by this node.

Example output snippet (simplified):

[
  {
    "json": {
      "id": "123",
      "name": "Version 1.0",
      "status": "open",
      "createdAt": "2023-01-01T12:00:00Z",
      ...
    }
  },
  {
    "json": {
      "id": "124",
      "name": "Version 1.1",
      "status": "closed",
      "createdAt": "2023-02-01T12:00:00Z",
      ...
    }
  }
]

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL of the OpenProject instance must be configured in the credentials.
  • Uses HTTP Basic Authentication with the API key encoded in Base64.
  • Relies on the OpenProject REST API v3 endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Incorrect base URL configuration may lead to connection errors.
    • Malformed filter strings (not in field=value format) will be ignored or cause unexpected results.
    • Requesting too large a limit may result in slow responses or timeouts.

  • Error messages:

    • OpenProject error response: <message> indicates an error returned by the OpenProject API, often due to invalid parameters or permissions.
    • Network or HTTP errors will show their message; verify connectivity and credentials.

  • Resolutions:

    • Ensure the API key and base URL are correctly set in the node credentials.
    • Use valid filter syntax and supported fields.
    • Adjust limit and offset values to reasonable numbers.
    • Check user permissions in OpenProject for accessing version resources.

Links and References

Discussion