TeamCity RESTAPI リファレンス 2026.1 ヘルプ

ビルドステータスアイコンを取得する

この記事では、ビルドステータスアイコン (Badge build successfulBadge build failed など) に使用できるメソッドを検討します。

特定のビルドのステータスアイコンを取得する

.svg アイコン(推奨されるアプローチ)を取得するには、次を使用します。

/app/rest/builds/<buildLocator>/statusIcon

ここで、buildLocatorBuildLocator エンティティです。

.png アイコンを取得するには、次を使用します。

/app/rest/builds/<buildLocator>/statusIcon.png

複数のビルドのステータスアイコンを取得する

複数のビルドのステータスアイコンを取得するには、/app/rest/builds/aggregated エンドポイントと strob ロケーターディメンションを使用します。

例: MyProject プロジェクトでのビルドステータスを要約したアイコンを取得するには、次を使用します。

/app/rest/builds/aggregated/strob:(buildType:(project:(id:MyProject)))/statusIcon

MyBuildConfiguration 構成のアクティブなブランチの最新のビルドを表すアイコンについては、以下を使用してください。

/app/rest/builds/aggregated/strob:(branch:(buildType:(id:MyBuildConfiguration),policy:active_history_and_active_vcs_branches),locator:(buildType:(id:MyBuildConfiguration)))/statusIcon

最新のタグ付きビルドのアイコンを取得

MyTag タグでタグ付けされた MyBuildConfiguration ビルドのアイコンをフェッチするには、次を使用します。

/app/rest/builds/buildType:(id:MyBuildConfiguration),tag:MyTag/statusIcon

特定のブランチでビルド実行のアイコンを取得する

MyBranch ブランチで実行される MyBuildConfiguration ビルドのステータスアイコンを取得するには、次を使用します。

/app/rest/builds/buildType:(id:MyBuildConfiguration),branch:MyBranch/statusIcon

GitHubReadme でビルドステータスを表示する

TeamCity サーバーでゲストアクセスが有効になっている場合は、次のマークアップを使用して、GitHub リポジトリの README に TeamCityPluginsByJetBrains_TeamcityGoogleTagManagerPlugin_Build ビルド構成のステータスを表示できます。

[![Build status](https://teamcity.jetbrains.com/guestAuth/app/rest/builds/buildType:(id:TeamCityPluginsByJetBrains_TeamcityGoogleTagManagerPlugin_Build)/statusIcon](https://<teamcity_server_address>/viewType.html?buildTypeId=TeamCityPluginsByJetBrains_TeamcityGoogleTagManagerPlugin_Build)

トラブルシューティング

返されたイメージに「データを取得する権限がありません」というテキスト (no-permission-to-get-data.svg) が含まれている場合は、次の点を確認してください。

  • サーバーではゲストユーザーアクセスが有効になっており、ゲストユーザーには参照されているビルド構成にアクセスするためのアクセス許可があります。OR

  • 参照されているビルド構成には、「ステータスウィジェットを有効にする」オプション ON があります。