auxua.OpenProject
3.1.0
dotnet add package auxua.OpenProject --version 3.1.0
NuGet\Install-Package auxua.OpenProject -Version 3.1.0
<PackageReference Include="auxua.OpenProject" Version="3.1.0" />
<PackageVersion Include="auxua.OpenProject" Version="3.1.0" />
<PackageReference Include="auxua.OpenProject" />
paket add auxua.OpenProject --version 3.1.0
#r "nuget: auxua.OpenProject, 3.1.0"
#:package auxua.OpenProject@3.1.0
#addin nuget:?package=auxua.OpenProject&version=3.1.0
#tool nuget:?package=auxua.OpenProject&version=3.1.0
auxua.OpenProject
OpenProject Client
To connect to an OpenProject instance and interact with its REST API, you can use this package.
It is based on the v3 API of OpenProject and .Net Standard 2.0.
Usage
Step 1: Configuration
Key to usage is the Base Adress and an API Key. You can get the API Key from your OpenProject profile settings.
var config = new BaseConfig()
{
PersonalAccessToken = Settings.ApiKey,
BaseUrl = Settings.ApiBaseUrl
};
Step 2: Creating and Using Client
var client = new auxua.OpenProject.OpenProjectClient(config);
Step 3: Example Usage
For example, to get a list of projects:
var projects = await client.Projects.GetProjectsAsync();
Or getting the according work packages:
var query = WorkPackageQuery.ForProject(id);
var wp = await client.WorkPackages.GetWorkPackagesAsync(query);
var wp2 = await client.WorkPackages.GetAllWorkPackagesAsync(query);
For more details of work packages, you may want to create the facade, which catches additional information in the background:
var testwp = wp2.Where(x => x.Subject == "Test Work Package").First();
var ftest = new WorkPackageFacade(testwp, client.CustomFields);
Current Status
| Read / Get | Write (Create/Update/Delete) | |
|---|---|---|
| Activities | ✅ | - |
| Attachments | ⭕ | ⭕ |
| News | ✅ | ✅ |
| Notifications | ✅ | ✅ (Mark [Un]Read) |
| Projects | ✅ | ⭕ |
| Relations | ✅ | ✅ |
| Time Tracking | ✅ | ✅ (Create) |
| Users | ✅ | - |
| Version | ✅ | ✅ |
| WorkPackages | ✅ | ✅ |
| WorkPackage Types | ✅ | - |
| WorkPackage Custom Fields | ✅ | - |
| Work Package Custom Options | ⚠️ (incomplete) | - |
Issues and Contributions
This project is open for issues and contributions. Feel free to open issues on GitHub or submit pull requests.
License and Usage
This project is licensed under the MIT License. See the LICENSE file for details.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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 was computed. 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. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
* Adding Create, Update, Delete Operations and more Endpoints