Package org.llorllale.youtrack.api

Fluent, object-oriented API for YouTrack.

See: Description

Interface Summary

Interface	Description
AssignedField	A Field that is attached to an Issue.
Comment	A comment created on a YouTrack Issue.
Comments	API for comments on an Issue.
Field	A property of issues.
Fields	Access to all the fields of a project that are configured for issues.
FieldValue	A value for some Field.
Issue	A YouTrack issue.
Issues	Issues API.
IssueTimeTracking	API for Issue timetracking.
Project	A YouTrack project.
ProjectField	An extended Field that provides its possible values.
Projects	Fetches projects from the YouTrack server.
ProjectTimeTracking	Access to a project's timetracking settings.
TimeTrackEntry	An entry in an issue's timetracking.
TimeTrackEntryType	The TimeTrackEntry's type.
UpdateIssue	API to update an Issue.
User	A registered user in YouTrack.
UsersOfIssue	Access the users of an issue.
UsersOfProject	Access the users of a project.
Xml	Encapsulation of the XML messages sent to/received from YouTrack.
YouTrack	Entry point for the YouTrack API.

Class Summary

Class	Description
DefaultYouTrack	Default implementation of YouTrack.
Issues.IssueSpec	Specifications for building an Issue.
IssueTimeTracking.EntrySpec	Specifications for creating a TimeTrackEntry on an Issue.

Package org.llorllale.youtrack.api Description

Fluent, object-oriented API for YouTrack.

Login

YouTrack supports various authentication strategies. youtrack-api implements:

• Username/password
• Permanent tokens
• Anonymous sessions (ie. the guest user)

Example: final Session session = new PermanentTokenLogin(youtrackUrl, myToken).login();
See the org.llorllale.youtrack.api.session package for more info.

Main Entry Point

The main entrypoint for the API is the YouTrack interface. Obtain an instance of the default implementation like this:
final YouTrack yt = new DefaultYouTrack(session);.

Projects

The Projects interface is used to find projects.
Example:

   final Optional<Project> project = new DefaultYoutrack(session)
       .projects()          //returns the Projects interface
       .get("projectId");   //returns an Optional<Project>

See interfaces Projects and Project.

Issues

You can find an issue like this:

   final Optional<Issue> issue = project.issues().get("issueId");

To create an issue, use Issues.create(org.llorllale.youtrack.api.Issues.IssueSpec):

   final Issue is = project.issues().create(new IssueSpec("summary", "description"));
 

See Issues and Issues.IssueSpec for more info.

Fields of an Issue

Note:
It is important to know that some fields typically found in most issue tracking software - like State and Priority - are not first class citizens in YouTrack, although they are typically present in project configurations on most teams. First class attributes of issues in YouTrack include properties such as creationDate, summary, and description (although optional). Behind the scenes, YouTrack supports fields like State and Priority through the use of custom fields that are configured (sometimes preconfigured) through a project's settings.

Usage:
To access a project's preconfigured fields:

   final Stream<ProjectField> fields = project.fields().stream();

To access all possible values for a field:

   final Stream<FieldValue> values = projectField.values();

Updating an issue's fields can be done in two ways:

• By selecting a org.llorllale.youtrack.api.SelectableFieldValue on one of the issue's fields
• By directly updating the issue via Issue.update()

Example of the former:

   issue.fields().stream()
        .filter(f -> "State".equals(f.name())
        .findAny().get()
        .change()           //opens a stream of SelectableFieldValue
        .filter(v -> "Done".equals(v.asString())
        .findAny().get()
        .apply();

Example of the latter:

   final ProjectField state = project.fields().stream()
        .filter(f -> "State".equals(f.name()))
        .findAny().get();
  final FieldValue done = state.values()
        .filter(v -> "Done".equals(v.asString())
        .findAny().get();
  final Issue issueUpdated = issue.update().field(state, done);

Since:

0.9.0

See Also:

Project Site.