YouTrack Standalone 2019.1 Help

Commands

This resource lets you apply commands to issues.

Resource

/api/commands

Returned entity

CommandList. For the description of the entity attributes, see Supported Fields section.

Supported methods

Supported sub-resources

CommandList attributes

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. Can be null.

visibility

CommandVisibility

Stores visibility settings for a comment added with the command.

query

String

Stores a command to apply. Can be null.

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. Can be null.

commands

Array of ParsedCommands

Stores a collection of commands parsed from the provided query. Read-only.

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. Read-only.

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.

Request syntax

POST /api/commands?{fields}

Request parameters

Parameter

Type

Description

fields

string

A list of CommandList attributes that should be returned in the response. If no field is specified, only the entityID is returned.

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 URI

https://example.myjetbrains.com/youtrack/api/commands

Sample request body

{ "query": "Fixed", "issues": [ { "id": "2-17" } ] }

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.

Sample request URI

https://example.myjetbrains.com/youtrack/api/commands?fields=issues(id,idReadable),query,visibility(permittedGroups(id,name),permittedUsers(id,login))

Sample request body

{ "query": "for me ", "issues": [ { "id": "2-15" } ], "silent": true, "comment": "Still cannot reproduce.", "visibility": { "$type": "CommandLimitedVisibility", "permittedGroups": [ { "id": "3-2" } ] } }

Sample response body

{ "query": "for me ", "issues": [ { "idReadable": "SP-16", "id": "2-15", "$type": "Issue" } ], "visibility": { "permittedGroups": [ { "id": "3-2" } ], "$type": "CommandLimitedVisibility" } }
Last modified: 17 May 2019