Operations with Specific Tag
This resource lets you access and work with tags in YouTrack.
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
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
GET /api/tags/{tagID}?{fields}{tagID} | 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/tags/6-4?fields=id,name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)Sample response body
{
"owner": {
"login": "john.doe",
"name": "John Doe",
"$type": "User"
},
"issues": [
{
"idReadable": "RAP-4",
"summary": "New issue with new tag",
"$type": "Issue"
}
],
"visibleFor": {
"name": "All Users",
"id": "3-0",
"$type": "UserGroup"
},
"name": "GET",
"id": "6-4",
"$type": "Tag"
}Update a Specific Tag
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
POST /api/tags/{tagID}?{fields}{tagID} | 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
Let's add the specified tag to some issues, and change its visibility.
Sample request
https://example.youtrack.cloud/api/tags/6-4?fields=id,name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)Sample request body
{
"issues": [
{
"idReadable": "RAP-2"
},
{
"idReadable": "RAP-4"
}
],
"visibleFor": {
"id": "3-4"
}
}Sample response body
{
"owner": {
"login": "john.doe",
"name": "John Doe",
"$type": "User"
},
"issues": [
{
"idReadable": "RAP-2",
"summary": "Example for Get specific issue tag",
"$type": "Issue"
},
{
"idReadable": "RAP-4",
"summary": "New issue with new tag",
"$type": "Issue"
}
],
"visibleFor": {
"name": "Rest Api Project Team",
"id": "3-4",
"$type": "UserGroup"
},
"name": "GET",
"id": "6-4",
"$type": "Tag"
}Delete a Specific Tag
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
DELETE /api/tags/{tagID}{tagID} | 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/tags/6-16