Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 4.5 KB

README.md

File metadata and controls

70 lines (46 loc) · 4.5 KB
Raw

official project

YouTrackSharp

YouTrackSharp

.NET library to access YouTrack API.

For more information on YouTrack visit jetbrains.com/youtrack.

Getting started

First of all, install YouTrackSharp into your project using a NuGet client.

Install-Package YouTrackSharp

If you want to work with pre-release builds, configure our MyGet feed as a package source.

To communicate with a YouTrack server instance, we'll need a connection. It is recommended to always use permanent tokens to authenticate against YouTrack, using the BearerTokenConnection.

var connection = new BearerTokenConnection("https://ytsharp.myjetbrains.com/youtrack/", "perm:abcdefghijklmn");

Once a connection is made, various services can be used. For example to get a list of projects the user has access to, the ProjectsService can be used:

var projectsService = connection.CreateProjectsService();
var projectsForCurrentUser = await projectsService.GetAccessibleProjects();

Other services are available as well, mapping to the YouTrack REST API endpoints and operations that are available.

Supported operations

YouTrackSharp is a .NET Library to access the YouTrack API. Main features:

  • All calls are async all the way.
  • Handles serialization of YouTrack's timestamps into DateTime where possible.
  • Authentication using permanent tokens.
  • Comes with a color indices list.

The following API's are currently supported:

Many other API's are not included yet - feel free to tackle one of the UpForGrabs issues and make YouTrackSharp better!

Supported YouTrack versions

YouTrackSharp versions follow YouTrack versioning. This means that YouTrackSharp 2018.4 supports YouTrack version 2018.4 as well as YouTrack InCloud for that version.

Some features will work with both newer and older versions of YouTrack as well but they are not officially suppported.

For YouTrack versions before 2018.4:

Be aware that these older branches are frozen and bug fixes nor new feature development is done on them.