This resource lets you apply commands to issues.
CommandList. For the description of the entity attributes, see Supported Fields section.
Represents list of command and related comment in YouTrack. Can be used to either apply a command or get command suggestions.
This table describes attributes of the
To receive an attribute in the response from the server, specify it explicitly in the
To update an attribute, provide it in the body of a POST request.
The ID of the command list.
A comment to add to an issue.
Stores visibility settings for a comment added with the command.
Stores a command to apply.
Current caret position. End of current command by default.
If true, the command is applied without notification. The default value is false.
Login for a user on whose behalf the command is executed. To use the runAs parameter, you must have the Low-level Administration permission.
|Array of ParsedCommands|
Stores a collection of commands parsed from the provided query.
|Array of Issues|
Stores a collection of issues to which the current command applies.
|Array of Suggestions|
Stores a collection of possible command suggestions.
Execute a Command
Applies command to the specified issues. The
query and at least one issue must be specified in the payload of the request.
A list of CommandList attributes that should be returned in the response. If no field is specified, only the
Set this parameter to
A minimal request for a command requires you to send in the request body a query - the command to apply, and a collection of issues that should be represented at least by their IDs. For this sample minimal request without the
fields parameter, the server sends a response with the
200 OK status and an empty body.
Sample request body
The following request assigns the specific issue to the current user and adds a new comment with restricted visibility. The command is applied silently, without sending notifications.