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

BuildLocator

ビルドエンティティをフィルタリングするためのロケーター文字列を表します。例:

  • id:1 — ID 1 のビルドを検索します。

  • buildType:<buildTypeLocator> — buildTypeLocator によって検出されたビルド構成でビルドを検索します。

  • defaultFilter:false,agent:<agentLocator> — defaultFilter を無効にして、agentLocator によって検出されたエージェントで実行されたビルドを検索します（以下を参照）。

Properties

ディメンション

データ型

フォーマット

説明

affectedProject

string

ProjectLocator

プロジェクト（直接または間接の親）ロケーター。

agent

string

AgentLocator

エージェントロケーター。

agentTypeId

integer

int32

ビルドの実行に使用されるエージェントの typeId。

any

boolean

状態は任意です。

artifactDependency

string

branch

string

BranchLocator

ブランチロケーター。

buildType

string

BuildTypeLocator

ビルドタイプロケーター。

canceled

boolean

キャンセルされます。

compatibleAgent

string

AgentLocator

エージェントロケーター。

composite

boolean

コンポジット。

count

integer

int32

ページ付けされた呼び出しの場合、ページごとに返すエンティティの数。

defaultFilter

boolean

true の場合、「通常の」ビルド (キャンセルされていない、開始に失敗していない、個人用ではない、デフォルトのブランチ (分岐ビルド構成) にある完了したビルド) のみを返すデフォルトのフィルターを適用します。

failedToStart

boolean

起動に失敗しました。

finishDate

string

date:<yyyyMMddTHHmmss+ZZZZ>,build:<build locator>,condition:<before/after>

日付またはビルドディメンションのいずれかが必要です。

finished

boolean

終了しました。

hanging

boolean

ぶら下がっています。

history

boolean

履歴構築です。

id

string

エンティティ ID。

item

string

item:(<locator1>),item:(<locator2>...)

複数のロケーターを提供し、結果の和集合を返します。

lookupLimit

integer

int32

処理を最新の <lookupLimit> エンティティに制限します。

number

string

ビルド番号文字列。

personal

boolean

個人的なビルドです。

pinned

boolean

固定されています。

project

string

ProjectLocator

プロジェクト（直接の親）ロケーター。

property

string

property:(name:<name>,value:<value>,matchType:<matchType>)

サポートされている値:

  • exists

  • not-exists

  • equals

  • does-not-equal

  • starts-with

  • contains

  • does-not-contain

  • ends-with

  • any

  • matches

  • does-not-match

  • more-than

  • no-more-than

  • less-than

  • no-less-than

  • ver-more-than

  • ver-no-more-than

  • ver-less-than

  • ver-no-less-than

queued

boolean

キューに入れられます。

queuedDate

string

date:<yyyyMMddTHHmmss+ZZZZ>,build:<build locator>,condition:<before/after>

日付またはビルドディメンションのいずれかが必要です。

revision

string

リビジョンをビルドします。

running

boolean

が走っています。

snapshotDependency

string

start

integer

int32

ページ化された呼び出しの場合、どのエンティティからページのレンダリングを開始するか。

startDate

string

date:<yyyyMMddTHHmmss+ZZZZ>,build:<build locator>,condition:<before/after>

日付またはビルドディメンションのいずれかが必要です。

state

string

サポートされている値:

  • queued

  • running

  • finished

  • any

status

string

ステータステキスト。

tag

string

TagLocator

タグロケーター。

taskId

integer

int32

ビルドまたはビルドプロモーションの ID。

user

string

UserLocator

個人用ビルドの場合、ビルドの所有者をチェックし、それ以外の場合はユーザーをトリガーします。

BranchLocatorBuildQueueLocator