CommandList
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 CommandList entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
comment | String | A comment to add to an issue. |
visibility | CommandVisibility | Stores visibility settings for a comment added with the command. |
query | String | Stores a command to apply. |
caret | Int | Current caret position. End of current command by default. |
silent | Boolean | If true, the command is applied without notification. The default value is false. |
usesMarkdown | Boolean | When true, a comment added with the command is parsed as Markdown formatted. Otherwise, the comment is parsed as YouTrack Wiki formatted. |
runAs | String | Login for a user on whose behalf the command is executed. To use the runAs parameter, you must have the Low-level Administration permission in the project for the target issue. |
commands | Array of ParsedCommands | Stores a collection of commands parsed from the provided query. |
issues | Array of Issues | Stores a collection of issues to which the current command applies. |
suggestions | Array of Suggestions | Stores a collection of possible command suggestions. |