redmine-api
4.14.0
dotnet add package redmine-api --version 4.14.0
NuGet\Install-Package redmine-api -Version 4.14.0
<PackageReference Include="redmine-api" Version="4.14.0" />
<PackageVersion Include="redmine-api" Version="4.14.0" />
<PackageReference Include="redmine-api" />
paket add redmine-api --version 4.14.0
#r "nuget: redmine-api, 4.14.0"
#addin nuget:?package=redmine-api&version=4.14.0
#tool nuget:?package=redmine-api&version=4.14.0
redmine-net-api
A modern and flexible .NET client library to interact with Redmine's REST API.
🚀 Features
- Full REST API support with CRUD operations
- Supports both XML and JSON data formats
- Handles GZipped server responses transparently
- Easy integration via NuGet package
- Actively maintained and community-driven
Resource | Read | Create | Update | Delete |
---|---|---|---|---|
Attachments | ✅ | ✅ | ❌ | ❌ |
Custom Fields | ✅ | ❌ | ❌ | ❌ |
Enumerations | ✅ | ❌ | ❌ | ❌ |
Files | ✅ | ✅ | ❌ | ❌ |
Groups | ✅ | ✅ | ✅ | ✅ |
Issues | ✅ | ✅ | ✅ | ✅ |
Issue Categories | ✅ | ✅ | ✅ | ✅ |
Issue Relations | ✅ | ✅ | ✅ | ✅ |
Issue Statuses | ✅ | ❌ | ❌ | ❌ |
My Account | ✅ | ❌ | ✅ | ❌ |
News | ✅ | ✅ | ✅ | ✅ |
Projects | ✅ | ✅ | ✅ | ✅ |
Project Memberships | ✅ | ✅ | ✅ | ✅ |
Queries | ✅ | ❌ | ❌ | ❌ |
Roles | ✅ | ❌ | ❌ | ❌ |
Search | ✅ | |||
Time Entries | ✅ | ✅ | ✅ | ✅ |
Trackers | ✅ | ❌ | ❌ | ❌ |
Users | ✅ | ✅ | ✅ | ✅ |
Versions | ✅ | ✅ | ✅ | ✅ |
Wiki Pages | ✅ | ✅ | ✅ | ✅ |
📦 Installation
Add the package via NuGet:
dotnet add package Redmine.Net.Api
Or via Package Manager Console:
Install-Package Redmine.Net.Api
🧑💻 Usage Example
using Redmine.Net.Api;
using Redmine.Net.Api.Types;
using System;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
var options = new RedmineManagerOptionsBuilder()
.WithHost("https://your-redmine-url")
.WithApiKeyAuthentication("your-api-key");
var manager = new RedmineManager(options);
// Retrieve an issue asynchronously
var issue = await manager.GetAsync<Issue>(12345);
Console.WriteLine($"Issue subject: {issue.Subject}");
}
}
Explore more usage examples on the Wiki.
📚 Documentation
Detailed API reference, guides, and tutorials are available in the GitHub Wiki.
🙌 Contributing
See the CONTRIBUTING.md for detailed guidelines.
🤝 Contributors
Thanks to all contributors!
<a href="https://github.com/zapadi/redmine-net-api/graphs/contributors"> <img src="https://contrib.rocks/image?repo=zapadi/redmine-net-api" /> </a>
📝 License
This project is licensed under the Apache License 2.0.
☕ Support
If you find this project useful, consider to support development.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
.NET Framework | net20 is compatible. net35 was computed. net40 is compatible. net403 was computed. net45 is compatible. net451 is compatible. net452 is compatible. net46 is compatible. net461 is compatible. net462 is compatible. net463 was computed. net47 is compatible. net471 is compatible. net472 is compatible. net48 is compatible. net481 is compatible. |
-
.NETFramework 2.0
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.0
- Microsoft.Bcl.Async (>= 1.0.168)
- Microsoft.Net.Http (>= 2.2.29)
- Newtonsoft.Json (>= 13.0.3)
- System.ValueTuple (>= 4.5.0)
-
.NETFramework 4.5
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.5.1
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.5.2
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.6
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.6.1
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.6.2
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.7
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.7.1
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.7.2
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.8
- Newtonsoft.Json (>= 13.0.3)
-
.NETFramework 4.8.1
- Newtonsoft.Json (>= 13.0.3)
-
net5.0
- Newtonsoft.Json (>= 13.0.3)
-
net6.0
- Newtonsoft.Json (>= 13.0.3)
-
net7.0
- Newtonsoft.Json (>= 13.0.3)
-
net8.0
- Newtonsoft.Json (>= 13.0.3)
-
net9.0
- Newtonsoft.Json (>= 13.0.3)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on redmine-api:
Package | Downloads |
---|---|
biz.dfch.CS.Redmine.Client
biz.dfch.CS.Redmine.Client ======================== Client for Redmine project management web application Assembly: biz.dfch.CS.Redmine.Client d-fens GmbH, General-Guisan-Strasse 6, CH-6300 Zug, Switzerland ## Download * Get it on [NuGet](https://www.nuget.org/packages/biz.dfch.CS.Redmine.Client/) * See [Releases](https://github.com/dfensgmbh/biz.dfch.CS.Redmine.Client/releases) and [Tags](https://github.com/dfensgmbh/biz.dfch.CS.Redmine.Client/tags) on [GitHub](https://github.com/dfensgmbh/biz.dfch.CS.Redmine.Client) |
GitHub repositories
This package is not used by any popular GitHub repositories.