DOCSEARCHbyAlgolia
Submit Docs

YouTrackSharp

repository·223·Indexed 41 days ago

https://github.com/jetbrains/youtracksharp

A .NET library providing asynchronous access to the YouTrack REST API. It allows developers to programmatically manage users, projects, issues, and time tracking through services such as UserService, ProjectsService, and IssuesService.

Tokens
627
Snippets
3
Records
5
Agent score
0%

What's inside YouTrackSharp

  1. Match YouTrackSharp version to your YouTrack instance

    223

    YouTrackSharp versions follow YouTrack's versioning scheme (e.g., YouTrackSharp 2018.4 is designed for YouTrack 2018.4 and YouTrack InCloud 2018.4).

    For older YouTrack versions, use the following legacy branches/packages:

    YouTrack VersionRecommended YouTrackSharp Version
    Before 2018.4YouTrackSharp 3.x
    Standalone 7.02.x branch or YouTrackSharp 2.x
    Standalone 6.52.x branch or YouTrackSharp 2.x
    Standalone 6.02.x branch or YouTrackSharp 2.x
    Standalone 5.x2.x branch or YouTrackSharp 2.x
    Standalone 4.x2.x branch or YouTrackSharp 2.x
    Standalone 3.x1.x branch or YouTrackSharp 1.x

    Note: Older branches are frozen and do not receive bug fixes or new features.

  2. Authenticate with YouTrack using BearerTokenConnection

    223

    To communicate with a YouTrack server, create a connection instance. It is recommended to use permanent tokens for authentication via the BearerTokenConnection class.

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

  4. Access YouTrack services via a connection

    223

    Once a BearerTokenConnection is established, you can create specific services to interact with different YouTrack API endpoints. For example, use CreateProjectsService() to access project-related operations.

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

  5. Overview of supported YouTrackSharp services

    223

    YouTrackSharp provides asynchronous services that map to the YouTrack REST API. The following services are currently supported:

    • UserService: User-related methods.
    • ProjectsService: Projects-related methods.
    • IssuesService: Issues-related methods.
    • TimeTrackingService: Time-tracking-related methods.
    • UserManagementService: Administration API for user management.
    • TimeTrackingManagementService: Administration API for Time Tracker management.