YouTrack InCloud 2019.2 Help

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 true, this tag will be automatically removed from an issue when the issue is resolved.

owner

User

A user who created — hence, owns — the watch folder. Read-only. Can be null.

visibleFor

UserGroup

Group of users that can see this watch folder. If the folder is visible only for its owner, this property is null. Can be 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. Can be null.

name

String

The name of the issue folder. Can be null.

Read a Specific IssueTag

Get settings of the tag with the specified ID.

Request syntax

GET /api/issueTags/{tagID}?{fields}

{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 entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issueTags/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": "IssueTag" }

Update a Specific IssueTag

Update settings of the tag with the specified ID.

Request syntax

POST /api/issueTags/{tagID}?{fields}

{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 entityID is returned

Sample

Let's add the specified tag to some issues, and change its visibility.

Sample request URI

https://example.myjetbrains.com/youtrack/api/issueTags/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": "IssueTag" }

Delete a Specific IssueTag

Delete a tag with the specified ID.

Request syntax

DELETE /api/issueTags/{tagID}

{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 entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issueTags/6-16
Last modified: 22 October 2019