Commands
This resource lets you apply commands to issues.
Resource | |
|---|---|
Returned entity | CommandList. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents list of command and related comment in YouTrack. Can be used to either apply a command or get command suggestions.
Below you can find the list of resources that let you work with this entity.
Commands
This table describes attributes of the CommandList entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the command list. |
comment | String | A comment to add to an issue. |
visibility | 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. |
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. |
commands | Stores a collection of commands parsed from the provided query. | |
issues | Stores a collection of issues to which the current command applies. | |
suggestions | Stores a collection of possible command suggestions. |
Applies a command to the specified issues.
Required fields: query - the command to apply, issues (id or idReadable of at least one issue that the command will be applied to).
POST /api/commands?{fields}&{muteUpdateNotifications}null | Database ID of CommandList |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of CommandList attributes that should be returned in the response. If no field is specified, only the |
muteUpdateNotifications | Boolean | 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.
https://example.youtrack.cloud/api/commands{
"query": "Fixed",
"issues": [
{
"idReadable": "SP-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.
https://example.youtrack.cloud/api/commands?fields=issues(id,idReadable),query,visibility(permittedGroups(id,name),permittedUsers(id,login)){
"query": "for me ",
"issues": [
{
"idReadable": "SP-16"
}
],
"silent": true,
"comment": "Still cannot reproduce.",
"visibility": {
"$type": "CommandLimitedVisibility",
"permittedGroups": [
{
"id": "3-2"
}
]
}
}{
"query": "for me ",
"issues": [
{
"idReadable": "SP-16",
"id": "2-15",
"$type": "Issue"
}
],
"visibility": {
"permittedGroups": [
{
"id": "3-2"
}
],
"$type": "CommandLimitedVisibility"
}
}