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 the server, specify it explicitly in the
fields
request parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
id | String | The ID of the issue tag. |
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 |
visibleFor | UserGroup | Deprecated. Use the Group of users that can see this tag. If the tag is visible only to its owner, this property is null. Can be null . |
updateableBy | UserGroup | Deprecated. Use the Group of users that can update this tag. If only the tag's owner can update it, this property is null. Can be null . |
readSharingSettings | WatchFolderSharingSettings | Users and groups that can see this tag. If the tag is visible only to its owner, this property contains an empty array. |
tagSharingSettings | TagSharingSettings | Users and groups that can use this tag. These users can add the tag to or remove the tag from the issues that they also have permission to view and update. If the tag can be used only by its owner, this property contains an empty array. |
updateSharingSettings | WatchFolderSharingSettings | Users and groups that can update this tag. If only the tag's owner can update it, this property contains an empty array. |
owner | User | A user who created — hence, owns — the watch folder. |
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 a tag, the user should be either its owner or be a part of the user group the 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
Sample response body
Update a Specific IssueTag
Update settings of the tag with the specified ID.
Required permissions
To update a tag, the user should be either its owner or be a part of the user group that can edit this 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
Sample request body
Sample response body
Delete a Specific IssueTag
Delete a tag with the specified ID.
Required permissions
To delete a tag, the user should be either its owner or be a part of the user group that can edit this 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 |