Redmine icon

Redmine

Consume Redmine API

Overview

This node integrates with the Redmine API to retrieve multiple issues based on various filtering and sorting criteria. It is designed to fetch a list of issues from a Redmine project, optionally including related data such as attachments, child issues, history, relations, and watchers.

Common scenarios where this node is beneficial include:

  • Extracting all open or closed issues for reporting or analysis.
  • Fetching issues assigned to a specific user or created by a particular author.
  • Retrieving issues filtered by creation or update dates, priorities, statuses, or custom fields.
  • Including detailed associated data like issue history or attachments for comprehensive issue tracking.

Practical example:

  • A project manager wants to get all open issues assigned to their team within the last month, sorted by creation date descending, including any attachments and issue history for review.

Properties

Name Meaning
Return All Whether to return all matching issues or limit the number of results.
Limit Maximum number of issues to return when "Return All" is false. Minimum value is 1. Default is 50.
Offset Number of issues to skip in the response, useful for pagination. Minimum value is 0.
Sort Column to sort the results by. Append :desc to sort in descending order (e.g., created_on:desc).
Include Associated data to include in the response. Options are: Attachments, Children (child issues), Journals (issue history), Relations (related issues), Watchers.
Filters Collection of filters to narrow down the issues returned. Includes:
   Assigned To ID Filter issues assigned to a specific user ID or "me" for the current user.
   Author ID Filter issues created by a specific user ID.
   Category ID Filter issues by category ID.
   Created On Enable filtering by creation date. Supports exact date, date range, after date, or before date.
   Custom Fields Filter by custom fields that have "Used as a filter" enabled. Specify field ID and value.
   Custom Status ID When status filter is set to custom, specify the exact status ID.
   Fixed Version ID Filter issues by fixed version ID.
   Issue ID Get specific issue(s) by ID. Multiple IDs can be comma-separated.
   Parent ID Filter issues whose parent issue has the given ID.
   Priority ID Filter issues by priority ID.
   Project ID Filter issues belonging to a specific project ID.
   Status ID Filter by issue status: Open, Closed, All, or Custom (requires specifying a custom status ID).
   Subject Filter issues by exact subject match.
   Subproject ID Filter issues from a subproject ID. Use special syntax to exclude subprojects if needed.
   Target Version ID Filter issues by target version ID.
   Tracker ID Filter issues by tracker ID.
   Updated On Enable filtering by updated date. Supports exact date, date range, after date, or before date.

Output

The node outputs an array of JSON objects representing the retrieved issues. Each object corresponds to one issue and contains all standard issue fields returned by the Redmine API, potentially enriched with included associated data such as attachments, child issues, journals, relations, and watchers depending on the selected options.

If binary data is present (e.g., file attachments), it would be represented accordingly, but this node primarily returns JSON data describing issues and their metadata.

Dependencies

  • Requires connection to a Redmine instance via its REST API.
  • Needs an API key credential for authentication.
  • The base URL of the Redmine server must be configured in the node credentials.
  • No additional external dependencies beyond the Redmine API and proper credentials.

Troubleshooting

  • Authentication errors: Ensure the API key and Redmine URL are correctly configured in the credentials.
  • Empty results: Check filter settings; overly restrictive filters may return no issues.
  • Invalid filter values: For example, using incorrect IDs or malformed date ranges can cause errors or empty responses.
  • Pagination issues: If not returning all results, verify the "Return All" and "Limit" properties.
  • API version compatibility: Some include options (like attachments) require Redmine 3.4.0 or later.
  • Error messages: Typically relay API error messages; check the message for hints (e.g., invalid parameter, unauthorized).

Links and References

Discussion