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 or a subset of issues for reporting or analysis.
  • Synchronizing issue data with other systems.
  • Monitoring issues by specific users, projects, or statuses.
  • Fetching detailed issue information including custom fields and associated metadata.

For example, you could use this node to get all open issues assigned to yourself created within the last month, sorted by creation date descending, including their attachments and watchers.

Properties

Name Meaning
Return All Whether to return all matching issues or limit the number of results.
Limit Maximum number of issues to return (used if "Return All" is false).
Offset Number of issues to skip before starting to collect the result set (useful for pagination).
Sort Column to sort the results by. Append :desc to sort in descending order (e.g., created_on:desc).
Include Additional associated data to include in each issue's response. Options: Attachments, Children (sub-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 with options for exact date, range, after, or before.
   Custom Fields Filter by custom fields that have filtering enabled. Specify field ID and value pairs.
   Custom Status ID Filter by a specific custom status ID (when status filter is set to custom).
   Fixed Version ID Filter issues by fixed version ID.
   Issue ID Filter by one or multiple issue IDs (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 (specific status ID).
   Subject Filter issues by exact subject match.
   Subproject ID Filter issues by 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 with options for exact date, range, after, or before.

Output

The node outputs an array of JSON objects representing the retrieved issues. Each object contains the issue data as returned by the Redmine API, including any requested associated data specified in the "Include" property (such as attachments, children, journals, relations, and watchers).

If binary data is included (e.g., attachments), it will be represented accordingly in the output but the specifics depend on the Redmine API response and are not detailed here.

Dependencies

  • Requires connection to a Redmine instance via its REST API.
  • Needs an API key credential for authentication with the Redmine server.
  • The node expects the base URL of the Redmine server and a valid API key to be configured in the credentials.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to access issues.
  • Empty results: Check filter criteria; overly restrictive filters or incorrect IDs may yield no results.
  • Pagination issues: If not returning all results, verify "Return All" is enabled or adjust "Limit" and "Offset" properly.
  • Invalid filter values: Using invalid IDs or unsupported filter formats can cause errors; verify IDs exist in Redmine.
  • API version compatibility: Some "Include" options require Redmine 3.4.0 or later (e.g., attachments).
  • Network errors: Confirm the Redmine server URL is reachable and correct.

Links and References

Discussion