Builds - List

リファレンス

Service:: Build

API Version:: 5.0

ビルドの一覧を取得します。

GET https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=5.0

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/build/builds?definitions={definitions}&queues={queues}&buildNumber={buildNumber}&minTime={minTime}&maxTime={maxTime}&requestedFor={requestedFor}&reasonFilter={reasonFilter}&statusFilter={statusFilter}&resultFilter={resultFilter}&tagFilters={tagFilters}&properties={properties}&$top={$top}&continuationToken={continuationToken}&maxBuildsPerDefinition={maxBuildsPerDefinition}&deletedFilter={deletedFilter}&queryOrder={queryOrder}&branchName={branchName}&buildIds={buildIds}&repositoryId={repositoryId}&repositoryType={repositoryType}&api-version=5.0

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '5.0' に設定する必要があります。
$top	query		integer int32	返されるビルドの最大数。
branchName	query		string	指定した場合は、このブランチを構築したブランチを構築するビルドにフィルターを適用します。
buildIds	query		string array (int32)	取得するビルドの ID を指定するコンマ区切りのリスト。
buildNumber	query		string	指定した場合は、このビルド番号に一致するビルドをフィルター処理します。プレフィックス検索を行うには、 * を追加します。
continuationToken	query		string	このメソッドの以前の呼び出しによって返される継続トークン。これは、次のビルドセットを返すために使用できます。
definitions	query		string array (int32)	定義 ID のコンマ区切りのリスト。指定した場合は、これらの定義をビルドするようにフィルター処理します。
deletedFilter	query		QueryDeletedOption	削除されたビルドを除外するか、含めるか、またはのみを返すかを示します。
maxBuildsPerDefinition	query		integer int32	定義ごとに返されるビルドの最大数。
maxTime	query		string date-time	指定した場合、指定された queryOrder に基づいて、この日付より前に完了/開始/キューに登録されたビルドにフィルター処理します。
minTime	query		string date-time	指定した場合、指定された queryOrder に基づいて、この日付より後に完了/開始/キューに登録されたビルドにフィルター処理します。
properties	query		string array (string)	取得するプロパティのコンマ区切りのリスト。
queryOrder	query		BuildQueryOrder	ビルドを返す順序。
queues	query		string array (int32)	キュー ID のコンマ区切りのリスト。指定した場合、これらのキューに対して実行されたビルドをフィルター処理します。
reasonFilter	query		BuildReason	指定した場合、この理由に一致するビルドをフィルター処理します。
repositoryId	query		string	指定した場合、このリポジトリからビルドされたビルドにフィルターを適用します。
repositoryType	query		string	指定した場合、この型のリポジトリからビルドされたビルドにフィルターを適用します。
requestedFor	query		string	指定した場合は、指定したユーザーに対して要求されたビルドをフィルター処理します。
resultFilter	query		BuildResult	指定した場合、この結果に一致するビルドをフィルター処理します。
statusFilter	query		BuildStatus	指定した場合、この状態に一致するビルドをフィルター処理します。
tagFilters	query		string array (string)	タグのコンマ区切りのリスト。指定した場合は、指定したタグを持つビルドにフィルター処理します。

応答

名前	型	説明
200 OK	Build[]	成功した操作

セキュリティ

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名前	説明
vso.build	ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、サービスフックを介してビルドイベントに関する通知を受信する機能を付与します。

定義

名前	説明
AgentPoolQueue	ビルドを実行するためのキューを表します。
Build	ビルドのデータ表現。
BuildController
BuildLogReference	ビルドログへの参照を表します。
BuildQueryOrder	ビルドを返す順序。
BuildReason	ビルドが作成された理由。
BuildRepository	ビルド定義で使用されるリポジトリを表します。
BuildRequestValidationResult	ビルド要求を検証した結果を表します。
BuildResult	ビルド結果。
BuildStatus	ビルドの状態。
ControllerStatus	コントローラーの状態。
DefinitionQueueStatus	この定義に対してビルドをキューに登録できるかどうかを示す値。
DefinitionReference	定義への参照を表します。
DefinitionType	定義の種類。
Demand	定義またはビルドで使用される需要を表します。
IdentityRef
ProjectState	プロジェクトの状態。
ProjectVisibility	プロジェクトの可視性。
PropertiesCollection	クラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。を除くすべてのプリミティブ型 (を持つ任意の `TypeCode != TypeCode.Object`型) の `DBNull` 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
QueryDeletedOption	削除されたビルドを除外するか、含めるか、またはのみ返すかを示します。
QueueOptions	ビルドをキューに入るための追加のオプション。
QueuePriority	ビルドの優先度。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
TaskAgentPoolReference	エージェントプールへの参照を表します。
TaskOrchestrationPlanReference	オーケストレーションプランへの参照を表します。
TeamProjectReference	TeamProject への浅い参照を表します。
ValidationResult	結果。

AgentPoolQueue

ビルドを実行するためのキューを表します。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
id	integer	キューの ID。
name	string	キューの名前。
pool	TaskAgentPoolReference	このキューで使用されるプール。
url	string	リソースへの完全な http リンク。

Build

ビルドのデータ表現。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
buildNumber	string	ビルドのビルド番号/名前。
buildNumberRevision	integer	ビルド番号のリビジョン。
controller	BuildController	ビルドコントローラー。これは、定義の種類が Xaml の場合にのみ設定されます。
definition	DefinitionReference	ビルドに関連付けられている定義。
deleted	boolean	ビルドが削除されたかどうかを示します。
deletedBy	IdentityRef	ビルドを削除したプロセスまたはユーザーの ID。
deletedDate	string	ビルドが削除された日付。
deletedReason	string	ビルドが削除された方法の説明。
demands	Demand[]	このビルドに必要なエージェント機能を表す要求の一覧。
finishTime	string	ビルドが完了した時刻。
id	integer	ビルドの ID。
keepForever	boolean	アイテム保持ポリシーによってビルドをスキップするかどうかを示します。
lastChangedBy	IdentityRef	ビルドを最後に変更したプロセスまたはユーザーを表す ID。
lastChangedDate	string	ビルドが最後に変更された日付。
logs	BuildLogReference	ビルドログに関する情報。
orchestrationPlan	TaskOrchestrationPlanReference	ビルドのオーケストレーション計画。
parameters	string	ビルドのパラメーター。
plans	TaskOrchestrationPlanReference[]	ビルドに関連付けられているオーケストレーションプラン (ビルド、クリーンアップ)
priority	QueuePriority	ビルドの優先度。
project	TeamProjectReference	チームプロジェクト。
properties	PropertiesCollection	クラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。を除くすべてのプリミティブ型 (を持つ任意の `TypeCode != TypeCode.Object`型) の `DBNull` 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは String として再チューニングされます。 Byte[] は base64 でエンコードされた文字列として必要です。
quality	string	xaml ビルドの品質 (良い、悪いなど)
queue	AgentPoolQueue	キューです。これは、定義の種類が Build の場合にのみ設定されます。
queueOptions	QueueOptions	ビルドをキューに入るための追加オプション。
queuePosition	integer	キュー内のビルドの現在位置。
queueTime	string	ビルドがキューに登録された時刻。
reason	BuildReason	ビルドが作成された理由。
repository	BuildRepository	リポジトリ。
requestedBy	IdentityRef	ビルドをキューに入れた ID。
requestedFor	IdentityRef	ビルドの代わりにキューに入れたの ID。
result	BuildResult	ビルド結果。
retainedByRelease	boolean	ビルドがリリースによって保持されているかどうかを示します。
sourceBranch	string	ソースブランチ。
sourceVersion	string	ソースバージョン。
startTime	string	ビルドが開始された時刻。
status	BuildStatus	ビルドの状態。
tags	string[]
triggerInfo	object	ビルドをトリガーした原因に関する Sourceprovider 固有の情報
triggeredByBuild	Build	ビルド完了トリガーを使用してこのビルドをトリガーしたビルド。
uri	string	ビルドの URI。
url	string	ビルドの REST URL。
validationResults	BuildRequestValidationResult[]	ビルド要求を検証した結果を表します。

BuildController

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
createdDate	string	コントローラーが作成された日付。
description	string	コントローラーの説明。
enabled	boolean	コントローラーが有効かどうかを示します。
id	integer	リソースの ID
name	string	リンクされたリソースの名前 (定義名、コントローラー名など)
status	ControllerStatus	コントローラーの状態。
updatedDate	string	コントローラーが最後に更新された日付。
uri	string	コントローラーの URI。
url	string	リソースへの完全な http リンク

BuildLogReference

ビルドログへの参照を表します。

名前	型	説明
id	integer	ログの ID。
type	string	ログの場所の種類。
url	string	ログリソースへの完全なリンク。

BuildQueryOrder

ビルドを返す順序。

名前	型	説明
finishTimeAscending	string	終了日時の昇順で並べ替えます。
finishTimeDescending	string	終了日時の降順で並べ替えます。
queueTimeAscending	string	キュー時間を昇順で並べ替えます。
queueTimeDescending	string	キュー時間の降順。
startTimeAscending	string	開始時刻を昇順で並べ替えます。
startTimeDescending	string	開始時刻の降順で並べ替えます。

BuildReason

ビルドが作成された理由。

名前	型	説明
all	string	すべての理由。
batchedCI	string	トリガー TriggerType.BatchedContinuousIntegration のビルドが開始されました。
buildCompletion	string	ビルドは、別のビルドが完了したときに開始されました。
checkInShelveset	string	トリガー ContinuousIntegrationType.Gated のビルドが開始されました。
individualCI	string	トリガー TriggerType.ContinuousIntegration のビルドが開始されました。
manual	string	ビルドは手動で開始されました。
none	string	理由はありません。この値は使用しないでください。
pullRequest	string	ビルドは pull request によって開始されました。リソースバージョン 3 で追加されました。
schedule	string	トリガー TriggerType.Schedule のビルドが開始されました。
triggered	string	ビルドは、アイテム保持ポリシーの目的でトリガーされました。
userCreated	string	ビルドはユーザーによって作成されました。
validateShelveset	string	プライベート検証のためにビルドが手動で開始されました。

BuildRepository

ビルド定義で使用されるリポジトリを表します。

名前	型	説明
checkoutSubmodules	boolean	サブモジュールをチェックアウトするかどうかを示します。
clean	string	リポジトリからコードを取得するときにターゲットフォルダーをクリーンするかどうかを示します。
defaultBranch	string	既定のブランチの名前。
id	string	リポジトリの ID。
name	string	リポジトリのフレンドリ名。
properties	object
rootFolder	string	ルートフォルダー。
type	string	リポジトリの型。
url	string	リポジトリの URL。

BuildRequestValidationResult

ビルド要求を検証した結果を表します。

名前	型	説明
message	string	結果に関連付けられているメッセージ。
result	ValidationResult	結果。

BuildResult

ビルド結果。

名前	型	説明
canceled	string	開始する前にビルドが取り消されました。
failed	string	ビルドが正常に完了しませんでした。
none	string	結果なし
partiallySucceeded	string	ビルドのコンパイルは正常に完了しましたが、他のエラーが発生しました。
succeeded	string	ビルドが正常に完了しました。

BuildStatus

ビルドの状態。

名前	型	説明
all	string	すべての状態。
cancelling	string	ビルドが取り消されています
completed	string	ビルドが完了しました。
inProgress	string	ビルドは現在進行中です。
none	string	状態なし。
notStarted	string	ビルドはまだ開始されていません。
postponed	string	ビルドはキューで非アクティブです。

ControllerStatus

コントローラーの状態。

名前	型	説明
available	string	ビルドコントローラーが現在使用可能であることを示します。
offline	string	ビルドコントローラーがそれ自体をオフラインにしたことを示します。
unavailable	string	ビルドコントローラーに接続できないことを示します。

DefinitionQueueStatus

この定義に対してビルドをキューに登録できるかどうかを示す値。

名前	型	説明
disabled	string	無効にした場合、定義キューではビルドをユーザーがキューに登録することは許可されず、システムはスケジュールされた、ゲート付き、または継続的インテグレーションのビルドをキューに入れられません。キューに既に存在するビルドは、システムによって開始されません。
enabled	string	定義キューを有効にすると、ビルドをユーザーがキューに入れ、システムはスケジュールされた、ゲート付き、継続的インテグレーションのビルドをキューに入れ、キューに入ったビルドがシステムによって開始されます。
paused	string	定義キューを一時停止すると、ビルドをユーザーがキューに入れ、システムはスケジュールされた、ゲート付き、および継続的インテグレーションのビルドをキューに入れます。キュー内のビルドは、システムによって開始されません。

DefinitionReference

定義への参照を表します。

名前	型	説明
createdDate	string	定義が作成された日付。
id	integer	参照先の定義の ID。
name	string	参照先の定義の名前。
path	string	定義のフォルダーパス。
project	TeamProjectReference	プロジェクトへの参照。
queueStatus	DefinitionQueueStatus	この定義に対してビルドをキューに登録できるかどうかを示す値。
revision	integer	定義リビジョン番号。
type	DefinitionType	定義の種類。
uri	string	定義の URI。
url	string	定義の REST URL。

DefinitionType

定義の種類。

名前	型	説明
build	string
xaml	string

Demand

定義またはビルドで使用される需要を表します。

名前	型	説明
name	string	要求によって参照される機能の名前。
value	string	要求された値。

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

ProjectState

プロジェクトの状態。

名前	型	説明
all	string	状態に関係なく、すべてのプロジェクト。
createPending	string	プロジェクトは作成のためにキューに登録されていますが、プロセスはまだ開始されていません。
deleted	string	プロジェクトが削除されました。
deleting	string	プロジェクトは削除中です。
new	string	プロジェクトは作成中です。
unchanged	string	プロジェクトは変更されていません。
wellFormed	string	プロジェクトは完全に作成され、使用できる状態になります。

ProjectVisibility

プロジェクトの可視性。

名前	型	説明
private	string	プロジェクトは、明示的なアクセス権を持つユーザーにのみ表示されます。
public	string	プロジェクトはすべてのユーザーに表示されます。

PropertiesCollection

クラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。を除くすべてのプリミティブ型 (を持つ任意の TypeCode != TypeCode.Object型) の DBNull 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は、その型を保持し、他のプリミティブは String として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。

名前	型	説明
count	integer	コレクション内のプロパティの数。
item	object
keys	string[]	コレクション内のキーのセット。
values	string[]	コレクション内の値のセット。

QueryDeletedOption

削除されたビルドを除外するか、含めるか、またはのみ返すかを示します。

名前	型	説明
excludeDeleted	string	削除されていないビルドのみを含めます。
includeDeleted	string	削除されたビルドと削除されていないビルドを含めます。
onlyDeleted	string	削除されたビルドのみを含めます。

QueueOptions

ビルドをキューに入るための追加のオプション。

名前	型	説明
doNotRun	string	ビルドのプラン ID を作成し、実行しないでください
none	string	キューオプションなし

QueuePriority

ビルドの優先度。

名前	型	説明
aboveNormal	string	通常の優先度を超えています。
belowNormal	string	通常の優先度を下回る。
high	string	優先度が高い。
low	string	低優先度。
normal	string	通常の優先度。

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

TaskAgentPoolReference

エージェントプールへの参照を表します。

名前	型	説明
id	integer	プール ID。
isHosted	boolean	このプールがサービスによって管理されているかどうかを示す値。
name	string	プール名。

TaskOrchestrationPlanReference

オーケストレーションプランへの参照を表します。

名前	型	説明
orchestrationType	integer	プランの種類。
planId	string	プランの ID。

TeamProjectReference

TeamProject への浅い参照を表します。

名前	型	説明
abbreviation	string	プロジェクトの省略形。
defaultTeamImageUrl	string	既定のチーム ID イメージへの URL。
description	string	プロジェクトの説明 (存在する場合)。
id	string	プロジェクト識別子。
name	string	プロジェクト名。
revision	integer	プロジェクトリビジョン。
state	ProjectState	プロジェクトの状態。
url	string	オブジェクトの完全なバージョンへの URL。
visibility	ProjectVisibility	プロジェクトの可視性。

ValidationResult

結果。

名前	型	説明
error	string
oK	string
warning	string

Share via