YouTrack Standalone 2019.1 Help

Issue Tags

Resource

/api/admin/customFieldSettings/bundles/user/individuals/tags

Returned entity

IssueTag. For the description of the entity attributes, see Supported Fields section.

Supported methods

IssueTag attributes

Represents a 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

Issues that have this tag.

color

FieldStyle

Tag color.

untagOnResolve

Boolean

If true this tag will be automatically removed from issue when the issue is resolved.

Read a List of IssueTags

Request syntax

GET /api/admin/customFieldSettings/bundles/user/individuals/tags?{fields}&{$top}&{$skip}

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.

$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.

Add a New IssueTag

Creates new tag. Name must be provided.

Request syntax

POST /api/admin/customFieldSettings/bundles/user/individuals/tags?{fields}

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.

Last modified: 12 April 2019