Tags
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 |
|
Represents a tag.
Below you can find the list of resources that let you work with this entity.
Article Tags
Extends WatchFolder
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 | The collection of issues that this tag is added to. | |
color | The color settings of the tag. | |
untagOnResolve | Boolean | If |
visibleFor | Deprecated. Use the Group of users that can see this tag. If the tag is visible only to its owner, this property is | |
updateableBy | Deprecated. Use the Group of users that can update this tag. If only the tag's owner can update it, this property is | |
readSharingSettings | Users and groups that can see this tag. If the tag is visible only to its owner, this property contains an empty array. | |
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 | Users and groups that can update this tag. If only the tag's owner can update it, this property contains an empty array. | |
owner | The user who created the watch folder. | |
name | String | The name of the issue folder. |
Get all tags added to the article that are visible to the current user.
GET /api/articles/{articleID}/tags?{fields}&{$top}&{$skip}null | Database ID of Tag |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Tag attributes that should be returned in the response. If no field is specified, only the |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
https://example.youtrack.cloud/api/articles/NP-A-12/tags?fields=id,name,owner(login,name),visibleFor(name,id)[
{
"owner": {
"login": "minnie.terry",
"name": "Minnie Terry",
"$type": "User"
},
"visibleFor": {
"name": "All Users",
"id": "3-0",
"$type": "UserGroup"
},
"name": "productivity",
"id": "6-0",
"$type": "Tag"
},
{
"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"
}
]Tag the article with an existing tag.
Required fields: id - the database ID of the tag.
Requires permissions: Read Article
The user must be either the tag owner or be a part of the user group that can use the tag.
POST /api/articles/{articleID}/tags?{fields}null | Database ID of Tag |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Tag attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/articles/NP-A-12/tags?fields=id,name,owner(login,name),visibleFor(name,id){
"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"
}{
"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"
}