YouTrack InCloud 2018.3 Help

YouTrack Workflow API

The @jetbrains/youtrack-scripting-api package includes a collection of modules. These modules provide the custom functions, methods, and constructors that let you reference and update entities in YouTrack. They also define the properties that are available for each entity.

The following modules are available:

Module

Description

date-time

This module contains functions that let you work with dates and times.

entities

Contains definitions for the entities in YouTrack that are accessible to workflows.

http

Contains definitions for objects and classes that exchange and transfer data over HTTP. The main class is Connection.

notifications

This module contains functionality for sending email messages. These messages are independent from the notification scheme that is used for subscriptions to issue updates in YouTrack. All of the components for these email messages are defined in the parameters for the function that is supported in this module. However, the messages are still sent by the SMTP server that is connected to your YouTrack installation.

search

This module contains functionality that lets you search for issues in YouTrack.

strings

This module provides support for a specific string utility from the standard Java library. All of the other methods that you can use to work with strings in workflows are taken from the standard JavaScript library and behave as described in the MDN documentation.

workflow

This module contains utility functions that display workflow-related messages and warnings in the user interface.

Last modified: 16 November 2018