Redmine icon

Redmine

Consume Redmine API

Overview

This node integrates with the Redmine API, specifically allowing users to manage projects among other resources like issues and users. The "Project - Create" operation enables creating a new project in Redmine by specifying essential details such as the project's name and identifier, along with optional additional fields.

Common scenarios for this node include automating project setup workflows, integrating project creation into larger automation pipelines, or synchronizing projects from other systems into Redmine.

For example, a user can automate the creation of multiple projects with predefined settings, including enabling specific modules (like Issue Tracking or Wiki), setting descriptions, and configuring visibility and membership inheritance.

Properties

Name Meaning
Name The name of the project to be created.
Identifier A unique identifier for the project, used in URLs.
Additional Fields Optional extra settings for the project:
- Custom Fields User-defined custom fields with ID and value pairs.
- Description A textual description of the project.
- Enabled Modules Modules to enable for the project. Options include Calendar, Documents, Files, Forums, Gantt, Issue Tracking, News, Repository, Time Tracking, and 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 if the project is public.
- Parent ID The ID of the parent project, if any, to establish project hierarchy.

Output

The node outputs an array of JSON objects representing the result of the create project operation. Each output item corresponds to one input item processed.

  • The json field contains the response data from the Redmine API about the newly created project, typically including project details such as ID, name, identifier, enabled modules, and other metadata.
  • If an error occurs during processing and the node is set to continue on failure, the output will contain an error field with the error message.

No binary data output is involved in this operation.

Dependencies

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

Troubleshooting

  • Common Issues:

    • Invalid or missing API key: The node will fail to authenticate with Redmine.
    • Incorrect project identifier format: Redmine requires identifiers to be unique and URL-friendly.
    • Missing required fields (Name, Identifier): The API will reject requests without these mandatory fields.
    • Network connectivity problems to the Redmine server.
  • Error Messages:

    • Authentication errors usually indicate invalid API keys or incorrect URL.
    • Validation errors from Redmine will specify which fields are missing or malformed.
    • Timeout or connection errors suggest network issues or unreachable Redmine server.

To resolve these:

  • Verify API key and Redmine URL correctness.
  • Ensure all required fields are provided and valid.
  • Check network connectivity and firewall settings.
  • Enable "Continue On Fail" in the node to handle errors gracefully during batch operations.

Links and References

Discussion