Operations with Specific Tag
This sub-resource lets you work with the tags that are added to the specific article.
Resource | |
Returned entity | Tag. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Tag attributes
Represents a tag.
Related Resources
Below you can find the list of resources that let you work with this entity.
Extends WatchFolder
Attributes
This table describes attributes of the Tag 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 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 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 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 | The user who created the watch folder. |
name | String | The name of the issue folder. |
Read a Specific Tag
Read a specific tag added to the article.
Required permissions
The user must be either the tag owner or be a part of the user group the tag is shared with.
Request syntax
GET /api/articles/{articleID}/tags/{tagID}?{fields}{tagID} | The database ID of the tag. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Tag attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
https://example.youtrack.cloud/api/articles/NP-A-12/tags/146-13?fields=id,name,owner(login,name),visibleFor(name,id)Sample response body
{
"owner": {
"login": "minnie.terry",
"name": "Minnie Terry",
"$type": "User"
},
"visibleFor": {
"name": "All Users",
"id": "3-0",
"$type": "UserGroup"
},
"name": "tip",
"id": "6-1",
"$type": "Tag"
}Remove a Tag from the Article
Remove a specific tag from the article.
Required permissions
Requires permissions: Read Article, Update Article
Request syntax
DELETE /api/articles/{articleID}/tags/{tagID}{tagID} | Database ID of Tag |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Tag attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
https://example.youtrack.cloud/api/articles/NP-A-12/tags/146-25