Skip to content
Padi edited this page Jan 4, 2025 · 14 revisions

Redmine.Net.Api Wiki

Welcome to the Redmine.Net.Api Wiki – your go-to guide for integrating .NET applications with the powerful Redmine REST API.

Whether you're a developer looking to streamline project management or contribute to the library, you'll find (almost) everything you need right here.

🌟 Key Features

  • Seamless API Integration: Effortlessly interact with Redmine's REST API.
  • Comprehensive Resource Support: Manage core entities like Projects, Issues, Users and Time Entries, alongside features such as Custom Fields, Wiki Pages and Versions.
  • Multi-Format Support: Handles both JSON and XML.
  • Performance-Optimized: GZip compression support ensures efficient data transfers.

🚀 Quick Start

Installation

Add the library to your project using:

dotnet add package redmine-api --version 4.6.9
Install-Package redmine-api -Version 4.6.9
<PackageReference Include="redmine-api" Version="4.6.9" />

Minimal Setup Example

using Redmine.Net.Api;
using Redmine.Net.Api.Types;

// Initialize the Redmine manager
var rm = new RedmineManager(new RedmineManagerOptionsBuilder()
    .WithHost("https://your-redmine-url")
    .WithApiKeyAuthentication("your-api-key"));

// Fetch a project
var project = rm.Get<Project>("project-identifier", null);

// Create an issue
var issue = new Issue
{
    Subject = "Bug Report",
    Project = IdentifiableName.Create<IdentifiableName>(project.Id);
};
manager.Create(issue);