Operations with Specific IssueTag
This resource lets you access and work with issue tags in YouTrack.
Resource | /api/issueTags/{tagID} |
Returned entity | IssueTag. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
IssueTag attributes
Represents an issue tag.
Extends WatchFolder
This table describes attributes of the IssueTag
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 |
---|---|---|
issues | Array of Issues | The collection of issues that this tag is added to. |
color | FieldStyle | The color settings of the tag. |
untagOnResolve | Boolean | If |
owner | User | A user who created — hence, owns — the watch folder. |
visibleFor | UserGroup | Group of users that can see this watch folder. If the folder is visible only for its owner, this property is null. |
updateableBy | UserGroup | Group of users that can update this watch folder. If only the folder's owner can update it, this property is null. |
name | String | The name of the issue folder. |
Read a Specific IssueTag
Get settings of the tag with the specified ID.
Required permissions
To view tag user should be either it's author or be a part of the user group tag is shared with.
Request syntax
{tagID} | Database ID of the tag. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueTag attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Sample response body
Update a Specific IssueTag
Update settings of the tag with the specified ID.
Required permissions
To update tag user should be either it's author or be a part of the user group that can edit tag.
Request syntax
{tagID} | Database ID of the tag. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueTag attributes that should be returned in the response. If no field is specified,only the |
Sample
Let's add the specified tag to some issues, and change its visibility.
Sample request URI
Sample request body
Sample response body
Delete a Specific IssueTag
Delete a tag with the specified ID.
Required permissions
To delete tag user should be either it's author or be a part of the user group that can edit tag.
Request syntax
{tagID} | Database ID of the tag. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of IssueTag attributes that should be returned in the response. If no field is specified,only the |