llms.txt : 機械可読形式のドキュメント索引。このページの Markdown バージョンも利用可能です。

YouTrack 開発者ポータルヘルプ

タグ

このリソースを使用すると、YouTrack のタグにアクセスして操作できます。

リソース

/api/tags

返されたエンティティ

タグ。エンティティ属性の説明については、「サポートされているフィールド」セクションを参照してください。

サポートされているメソッド

サポートされているサブリソース

タグ属性

タグを表します。

Related Resources

以下に、このエンティティを操作できるリソースのリストを示します。

WatchFolder を拡張

Attributes

このテーブルは、Tag エンティティの属性について説明しています。

  • サーバーからの応答で属性を受け取るには、fields 要求パラメーターでその属性を明示的に指定してください。

  • 属性を更新するには、POST リクエストの本文にそれを指定します。

フィールド

タイプ

説明

id

文字列

タグの ID。Read-only

課題

課題の配列

このタグが追加される課題のコレクション。

色

FieldStyle

タグの色設定。

untagOnResolve

Boolean

true の場合、課題が解決されると、このタグは課題から自動的に削除されます。

visibleFor

UserGroup

非推奨。代わりに readSharingSettings 属性を使用してください。

このタグを表示できるユーザーのグループ。タグがその所有者のみに表示される場合、このプロパティは null です。

Can be null .

updateableBy

UserGroup

非推奨。代わりに updateSharingSettings 属性を使用してください。

このタグを更新できるユーザーのグループ。タグの所有者のみがタグを更新できる場合、このプロパティは null です。

Can be null .

readSharingSettings

WatchFolderSharingSettings

このタグを表示できるユーザーとグループ。タグが所有者のみに表示される場合、このプロパティには空の配列が含まれます。Read-only

タグ共有設定

TagSharingSettings

このタグを使用できるユーザーとグループ。これらのユーザーは、表示と更新の権限も持っている課題にタグを追加したり、課題からタグを削除したりできます。タグをその所有者のみが使用できる場合、このプロパティには空の配列が含まれます。Read-only

updateSharingSettings

WatchFolderSharingSettings

このタグを更新できるユーザーとグループ。タグの所有者のみがタグを更新できる場合、このプロパティには空の配列が含まれます。Read-only

オーナー

ユーザー

監視フォルダーを作成したユーザー。Read-only Can be null

名前

文字列

課題フォルダーの名前。

タグのリストを読む

現在のユーザーに表示されているすべてのタグを取得します。

Request syntax

GET /api/tags?{fields}&{$top}&{$skip}&{query}

null

タグのデータベース ID

Request parameters

パラメーター

タイプ

説明

フィールド

文字列

応答で返されるタグ属性のリスト。フィールドが指定されていない場合は、entityID のみが返されます。

$skip

Int

オプション。最初のエンティティを返す前にスキップする、返されるエンティティ数を設定できます。

$top

Int

オプション。応答で返されるエントリの最大数を指定できます。$top 値を設定しない場合、サーバーは返されるエントリの最大数を制限します。

サーバーは、コレクションを返すほとんどのリソースに対して最大 42 のエントリを返します。詳細については、「ページ付け」を参照してください。

問い合わせ

文字列

タグ検索クエリ。タグのリストをフィルターするには、タグの名前を使用します。検索クエリの詳細については、「照会の構文」を参照してください。

Sample

サンプルリクエスト

https://example.youtrack.cloud/api/tags?fields=name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)&$skip=4&$top=3

応答本文のサンプル

[ { "owner": { "login": "john.doe", "name": "John Doe", "$type": "User" }, "issues": [], "visibleFor": null, "name": "Useful", "$type": "Tag" }, { "owner": { "login": "jane.doe", "name": "Jane Doe", "$type": "User" }, "issues": [], "visibleFor": { "name": "All Users", "id": "3-0", "$type": "UserGroup" }, "name": "Nice task", "$type": "Tag" }, { "owner": { "login": "john.doe", "name": "John Doe", "$type": "User" }, "issues": [], "visibleFor": { "name": "All Users", "id": "3-0", "$type": "UserGroup" }, "name": "Regression", "$type": "Tag" } ]

新しいタグを追加

新規タグを作成します。

必須フィールド: name

Required permissions

権限が必要です: ウォッチフォルダーを作成する

Request syntax

POST /api/tags?{fields}

null

タグのデータベース ID

Request parameters

パラメーター

タイプ

説明

フィールド

文字列

応答で返されるタグ属性のリスト。フィールドが指定されていない場合は、entityID のみが返されます。

Sample

新しいタグを作成して、特定のユーザーグループと共有しましょう。

サンプルリクエスト

https://example.youtrack.cloud/api/tags?fields=name,owner(login,name),visibleFor(name,id),issues(idReadable,summary)

サンプルリクエストボディ

{ "name" : "4theRelease!", "visibleFor" : { "id":"3-2" } }

応答本文のサンプル

{ "owner": { "login": "john.doe", "name": "John Doe", "$type": "User" }, "issues": [], "visibleFor": { "name": "Sample Project Team", "id": "3-2", "$type": "UserGroup" }, "name": "4theRelease!", "$type": "Tag" }
2026 年 7 月 04 日