Redmine icon

Redmine

Consume Redmine API

Overview

This node integrates with the Redmine project management system API, allowing users to perform various operations on Redmine resources such as issues, projects, and users. Specifically, for the Project - Update operation, it updates an existing project in Redmine by modifying its properties like description, enabled modules, homepage URL, visibility, parent project, and custom fields.

Common scenarios where this node is beneficial include:

  • Automating project updates based on external triggers or workflows.
  • Synchronizing project details from other systems into Redmine.
  • Managing project configurations programmatically without manual intervention.

For example, you could use this node to update a project's description and enable or disable specific modules automatically when certain conditions are met in your workflow.

Properties

Name Meaning
Project ID The unique identifier of the project to update. This is required to specify which project will be modified.
Additional Fields A collection of optional fields to update on the project:
- Custom Fields Multiple custom fields can be set by specifying their ID and corresponding value.
- Description Text description of the project.
- Enabled Modules List of modules to enable for the project. Options include: Calendar, Documents, Files, Forums, Gantt, Issue Tracking, News, Repository, Time Tracking, Wiki.
- Homepage URL of the project's homepage.
- Inherit Members Boolean flag indicating whether the project should inherit members from its parent project.
- Is Public Boolean flag indicating whether the project is publicly visible.
- Parent ID The ID of the parent project, if any, to establish a project hierarchy.

Output

The node outputs an array of JSON objects representing the updated project data returned from the Redmine API after the update operation. Each output item corresponds to one input item processed.

If the update fails for an item and "Continue On Fail" is enabled, the output for that item will contain an error message under the json.error field.

No binary data output is produced by this node.

Dependencies

  • Requires access to a Redmine instance with API enabled.
  • Needs an API key credential configured in n8n to authenticate requests to the Redmine API.
  • The node uses the Redmine REST API endpoints internally to perform project update operations.

Troubleshooting

  • Invalid Project ID: If the specified project ID does not exist, the API will return an error. Verify the project ID is correct.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update projects.
  • Invalid Field Values: Providing invalid values for fields like enabled modules or custom fields may cause errors. Double-check allowed options and formats.
  • Network Issues: Connectivity problems with the Redmine server will cause request failures.
  • Continue On Fail Behavior: When enabled, errors for individual items do not stop execution but are returned in the output for inspection.

Links and References

Discussion