Skip to content

Saulis/YouTrack.Rest

Repository files navigation

YouTrack.Rest

Easy-to-use .NET client for Jetbrains' YouTrack 4.x/5.x REST API (http://www.jetbrains.com/youtrack)

Latest officially tested version: 5.2.1

Built on top of RestSharp: https://github.com/restsharp/RestSharp / http://restsharp.org and CastleProject's DynamicProxy: https://github.com/castleproject/Castle.Core-READONLY / http://www.castleproject.org/

Usage

// First, create the client instance
IYouTrackClient youTrackClient = new YouTrackClient("http://youtrack.address.com", "login", "password");

// Fetching and creating issues is done using the IssueRepository
IIssueRepository issueRepository = youTrackClient.GetIssueRepository();

// Creating issue
IIssue issue = issueRepository.CreateIssue("project", "summary", "description");

// YouTrack.Rest uses Castle DynamicProxy for lazy loading which allows you to execute 
// various commands related to an issue without actually fetching the issue from YouTrack.
issue.AttachFile(@"C:\temp\foo.jpg");
issue.AddComment("blah blah");

// Using properties which use issue details will trigger a REST request:
Console.WriteLine(issue.Summary);

Supported API Features (v1.2.0)

  • Issues

    • Create New Issue
    • Get an Issue
    • Check that an Issue Exists
    • Get Attachments of an Issue
    • Get Comments of an Issue
    • Attach File to an Issue
    • Delete an Issue
    • Apply Command(s) to an Issue
    • Get Issues in a Project
    • Remove a Comment for an Issue
  • Admin

    • Projects
      • Create a new project
      • Get project
      • Delete project
      • Get project subsystems
      • Add subsystem to project
    • Users
      • Create a new user
      • Delete user
      • Get user
      • Add user to group
      • Get users groups
      • Get user roles
      • Create user group
      • Assign user role to user group
      • Delete user group
      • Get all user groups
      • Get user group roles

Contributing

Don't see the feature you need in the list? Feel free to post your own implementations or bug fixes and I'll be happy to integrate them into the code!

You can also post an issue or send me a message and I'll try to sort it out.

  • Alright, what do I need to know?

About

Another .NET client for the YouTrack REST API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages