redmine-net-api is a library for communicating with a Redmine project management application.
- Uses Redmine's REST API.
- Supports both XML and JSON formats.
- Supports GZipped responses from servers.
- This API provides access and basic CRUD operations (create, read, update, delete) for the resources described below:
| 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 | ✓ | ✓ | ✓ | ✓ |
Please review the pages on how to use redmine-net-api.
Contributions are really appreciated!
A good way to get started (flow):
- Fork the redmine-net-api repository.
- Create a new branch in your current repos from the 'master' branch.
- 'Check out' the code with Git, GitHub Desktop, SourceTree, GitKraken, etc.
- Push commits and create a Pull Request (PR) to redmine-net-api.
The API is released under Apache 2 open-source license. You can use it for both personal and commercial purposes, build upon it and modify it.
Thanks to all the people who already contributed!
I would like to thank:
-
JetBrains for my Open Source ReSharper licence,
-
AppVeyor for allowing free build CI services for Open Source projects
