entities

Represents VCS-related items such as commits and pull requests.

Represents the collection of custom attributes that have been added to user profiles. To retrieve a value that is stored in the profile for a referenced user, use the attribute value as the key. The entire object is read-only.

The common ancestor for all entity types.

Represents a value that is stored in a custom field that stores a build type.

An entity that retrieves VCS changes and creates their representation in YouTrack.

Represents a value that is stored in a custom field. The custom fields themselves are represented by the Fields class.

Represents a custom field in a project that stores a UserGroup type.

Represents a file that is attached to an issue.

TODO class documentation missing

Represents a tag.

An object that enables traversal through the elements in a collection.

Represents a custom field in a project that stores a value as a period type. We use org.joda.time.Period as a base class for period values. While you can read the class documentation at http://joda-time.sourceforge.net/apidocs/org/joda/time/Period.html, please note that we support only class members which use the Period class and primitive types like String and int.

Represents a YouTrack project.

Represents a value in a custom field that stores a version type.

Represents a pull request state.

The `Requirements` object serves two purposes. First, it functions as a safety net. It specifies the set of entities that must exist for a rule to work as expected. Whenever one or more rule requirements are not met, corresponding errors are shown in the workflow administration UI. The rule is not executed until all of the problems are fixed. Second, it functions as a reference. Each entity in the requirements is plugged into the `context` object, so you can reference entities from inside your context-dependent functions (like an `action` function). There are two types of requirements: project-wide and system-wide. Project-wide requirements contain a list of custom fields that must be attached to each project that uses the rule as well as the required values from the sets of values for each custom field. System-wide requirements contain a list of other entities that must be available in YouTrack. This includes users, groups, projects, issues, tags, saved searches, and issue link types.

The `Set` object stores unique values of any type, whether primitive values or object references. The Set is used as storage for all multi-value objects in this API: custom fields that store multiple values, issue links, issues in a project, and so on. You can access single values in the collection directly (see first(), last(), get(index)), use an iterator (see entries(), values()), or traverse with forEach(visitor) and find(predicate) methods. The workflow API is based on ECMAScript 5.1. This Set implementation mimics the functionality supported by the ES 6 Set interface.

Represents a sprint that is associated with an agile board. Each sprint can include issues from one or more projects.

Represents a custom field that stores a string of characters as text. When displayed in an issue, the text is shown as formatted in Markdown.

Represents a group of users.

Represents a commit that is attached to an issue.

Represents a common ancestor of classes that represent tags and saved searches.