Pull Requests - Create
pull request を作成します。
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=7.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?supportsIterations={supportsIterations}&api-version=7.1-preview.1
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
repository
|
path | True |
string |
pull request のターゲット ブランチのリポジトリ ID。 |
project
|
path |
string |
プロジェクト ID またはプロジェクト名 |
|
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。 |
supports
|
query |
boolean |
true の場合、pull request への後続のプッシュは個別に確認できます。 この機能が必要ない場合は、パフォーマンス上の理由から大きな pull request の場合は、これを false に設定します。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
他の関連オブジェクトへのリンク。 |
artifactId |
string |
この pull request を一意に識別する文字列。 pull request の成果物 ID を生成するには、次のテンプレートを使用します。 |
autoCompleteSetBy |
Identity |
設定されている場合、この pull request に対してオートコンプリートが有効になり、これが有効になっている ID になります。 |
closedBy |
Identity |
pull request を閉じたユーザー。 |
closedDate |
string |
pull request が閉じられた (完了、破棄、または外部でマージされた) 日付。 |
codeReviewId |
integer |
pull request のコード レビュー ID。 内部使用。 |
commits |
Git |
pull request に含まれるコミット。 |
completionOptions |
Git |
pull request の完了時のマージ方法に影響するオプション。 |
completionQueueTime |
string |
pull request が完了するキューに入った最新の日付。 内部使用。 |
createdBy |
Identity |
pull request を作成したユーザーの ID。 |
creationDate |
string |
pull request が作成された日付。 |
description |
string |
pull request の説明。 |
forkSource |
Git |
これがフォークの PR の場合、そのソースに関する情報が含まれます。 |
hasMultipleMergeBases |
boolean |
複数のマージベースの警告 |
isDraft |
boolean |
下書き/WIP プル要求。 |
labels |
Web |
pull request に関連付けられているラベル。 |
lastMergeCommit |
Git |
最新の pull request マージのコミット。 空の場合、最新のマージは進行中か、失敗しました。 |
lastMergeSourceCommit |
Git |
最後の pull request マージ時のソース ブランチの先頭にあるコミット。 |
lastMergeTargetCommit |
Git |
最後の pull request マージ時のターゲット ブランチの先頭にあるコミット。 |
mergeFailureMessage |
string |
設定した場合、この理由で pull request のマージに失敗しました。 |
mergeFailureType |
Pull |
pull request マージの失敗の種類 (存在する場合)。 |
mergeId |
string |
pull request マージの実行に使用されるジョブの ID。 内部使用。 |
mergeOptions |
Git |
pull request マージの実行時に使用されるオプション。 完了は 1 回だけ行われ、pull request のソース ブランチが変更されるたびに新しいマージが実行されるため、これらは完了オプションとは別です。 |
mergeStatus |
Pull |
pull request マージの現在の状態。 |
pullRequestId |
integer |
pull request の ID。 |
remoteUrl |
string |
内部使用。 |
repository |
Git |
pull request のターゲット ブランチを含むリポジトリ。 |
reviewers |
Identity |
投票の状態と共に、pull request のレビュー担当者の一覧。 |
sourceRefName |
string |
pull request のソース ブランチの名前。 |
status |
Pull |
pull request の状態。 |
supportsIterations |
boolean |
true の場合、この pull request は複数のイテレーションをサポートします。 イテレーションのサポートは、pull request のソース ブランチへの個々のプッシュを確認できることを意味し、1 回のイテレーションに残されたコメントは、今後のイテレーション全体で追跡されます。 |
targetRefName |
string |
pull request のターゲット ブランチの名前。 |
title |
string |
pull request のタイトル。 |
url |
string |
内部使用。 |
workItemRefs |
Resource |
この pull request に関連付けられているすべての作業項目参照。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Git |
成功した操作 |
セキュリティ
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.code_write | ソース コードの読み取り、更新、削除、コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するメタデータへのアクセスを許可します。 また、pull request とコード レビューを作成および管理したり、サービス フックを介してバージョン管理イベントに関する通知を受信したりすることもできます。 |
例
Sample Request
POST https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests?api-version=7.1-preview.1
{
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"title": "A new feature",
"description": "Adding a new feature",
"reviewers": [
{
"id": "d6245f20-2af8-44f4-9451-8107cb2767db"
}
]
}
Sample Response
{
"repository": {
"id": "3411ebc1-d5aa-464f-9615-0b527bc66719",
"name": "2016_10_31",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719",
"project": {
"id": "a7573007-bbb3-4341-b726-0c4148a07853",
"name": "2016_10_31",
"description": "test project created on Halloween 2016",
"url": "https://dev.azure.com/fabrikam/_apis/projects/a7573007-bbb3-4341-b726-0c4148a07853",
"state": "wellFormed",
"revision": 7
},
"remoteUrl": "https://dev.azure.com/fabrikam/_git/2016_10_31"
},
"pullRequestId": 22,
"codeReviewId": 22,
"status": "active",
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"creationDate": "2016-11-01T16:30:31.6655471Z",
"title": "A new feature",
"description": "Adding a new feature",
"sourceRefName": "refs/heads/npaulk/my_work",
"targetRefName": "refs/heads/new_feature",
"mergeStatus": "queued",
"mergeId": "f5fc8381-3fb2-49fe-8a0d-27dcc2d6ef82",
"lastMergeSourceCommit": {
"commitId": "b60280bc6e62e2f880f1b63c1e24987664d3bda3",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
},
"lastMergeTargetCommit": {
"commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"reviewers": [
{
"reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
"vote": 0,
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
}
],
"url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22"
},
"repository": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719"
},
"workItems": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/workitems"
},
"sourceBranch": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
},
"targetBranch": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
},
"sourceCommit": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
},
"targetCommit": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
},
"createdBy": {
"href": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
},
"iterations": {
"href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/iterations"
}
},
"supportsIterations": true,
"artifactId": "vstfs:///Git/PullRequestId/a7573007-bbb3-4341-b726-0c4148a07853%2f3411ebc1-d5aa-464f-9615-0b527bc66719%2f22"
}
定義
名前 | 説明 |
---|---|
Change |
|
Git |
|
Git |
Git コミットと関連するメタデータを記述するプロパティを提供します。 |
Git |
フォーク参照に関する情報。 |
Git |
pull request に関連付けられているすべてのデータを表します。 |
Git |
pull request の完了方法に関する基本設定。 |
Git |
pull request マージの作成時に使用されるオプション。 |
Git |
完了時に pull request をマージするために使用する戦略を指定します。 MergeStrategy が値に設定されていない場合、SquashMerge == false の場合、FF なしのマージが作成されます。 MergeStrategy が値に設定されていない場合、SquashMerge == true の場合、pull request コミットはスカッシュされます。 SquashMerge プロパティは非推奨です。 すべてのケースで MergeStrategy を明示的に設定することをお勧めします。 MergeStrategy に明示的な値が指定されている場合、SquashMerge プロパティは無視されます。 |
Git |
|
Git |
|
Git |
|
Git |
このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれます。 |
Git |
状態を一意に識別する状態コンテキスト。 |
Git |
状態の状態。 |
Git |
|
Git |
Git 操作のユーザー情報と日付。 |
Identity |
|
Identity |
pull request に対する投票を含む ID 情報。 |
Item |
|
Item |
|
Project |
プロジェクトの状態。 |
Project |
プロジェクトの可視性。 |
Pull |
pull request マージの現在の状態。 |
Pull |
pull request マージの失敗の種類 (存在する場合)。 |
Pull |
pull request の状態。 |
Reference |
REST 参照リンクのコレクションを表す クラス。 |
Resource |
|
Team |
TeamProjectCollection の参照オブジェクト。 |
Team |
TeamProject への浅い参照を表します。 |
Version |
アイテムに対して行われた変更の種類。 |
Web |
ワイヤを介して送信されるタグ定義の表現。 |
ChangeCountDictionary
GitChange
名前 | 型 | 説明 |
---|---|---|
changeId |
integer |
変更のグループ内の変更の ID。 |
changeType |
Version |
アイテムに対して行われた変更の種類。 |
item |
string |
現在のバージョン。 |
newContent |
Item |
変更後のアイテムの内容。 |
newContentTemplate |
Git |
新しい変更をプッシュするときに使用する新しいコンテンツ テンプレート。 |
originalPath |
string |
現在のパスと異なる場合は、アイテムの元のパス。 |
sourceServerItem |
string |
サーバー上の項目のパス。 |
url |
string |
アイテムを取得する URL。 |
GitCommitRef
Git コミットと関連するメタデータを記述するプロパティを提供します。
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
関連する REST 参照リンクのコレクション。 |
author |
Git |
コミットの作成者。 |
changeCounts |
Change |
コミットに含まれる変更の種類 (編集、削除など) の数。 |
changes |
Git |
コミットに含まれる変更の列挙。 |
comment |
string |
コミットのコメントまたはメッセージ。 |
commentTruncated |
boolean |
完全な Git コミット コメント メッセージからコメントが切り捨てられているかどうかを示します。 |
commitId |
string |
コミットの ID (SHA-1)。 |
commitTooManyChanges |
boolean |
コミットに含まれる変更が多すぎて表示できないことを示します |
committer |
Git |
コミットのコミッター。 |
parents |
string[] |
このコミットの親コミット ID の列挙。 |
push |
Git |
このコミットに関連付けられているプッシュ。 |
remoteUrl |
string |
コミットへのリモート URL パス。 |
statuses |
Git |
コミットに追加情報を関連付ける可能性があるサービスと拡張機能からの状態メタデータの一覧。 |
url |
string |
このリソースの REST URL。 |
workItems |
Resource |
このコミットに関連付けられている作業項目の一覧。 |
GitForkRef
フォーク参照に関する情報。
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
REST 参照リンクのコレクションを表す クラス。 |
creator |
Identity |
|
isLocked |
boolean |
|
isLockedBy |
Identity |
|
name |
string |
|
objectId |
string |
|
peeledObjectId |
string |
|
repository |
Git |
フォークのリポジトリ ID。 |
statuses |
Git |
このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。 |
url |
string |
GitPullRequest
pull request に関連付けられているすべてのデータを表します。
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
他の関連オブジェクトへのリンク。 |
artifactId |
string |
この pull request を一意に識別する文字列。 pull request の成果物 ID を生成するには、次のテンプレートを使用します。 |
autoCompleteSetBy |
Identity |
設定されている場合、この pull request に対してオートコンプリートが有効になり、これが有効になっている ID になります。 |
closedBy |
Identity |
pull request を閉じたユーザー。 |
closedDate |
string |
pull request が閉じられた (完了、破棄、または外部でマージされた) 日付。 |
codeReviewId |
integer |
pull request のコード レビュー ID。 内部使用。 |
commits |
Git |
pull request に含まれるコミット。 |
completionOptions |
Git |
pull request の完了時のマージ方法に影響するオプション。 |
completionQueueTime |
string |
pull request が完了するキューに入った最新の日付。 内部使用。 |
createdBy |
Identity |
pull request を作成したユーザーの ID。 |
creationDate |
string |
pull request が作成された日付。 |
description |
string |
pull request の説明。 |
forkSource |
Git |
これがフォークの PR の場合、そのソースに関する情報が含まれます。 |
hasMultipleMergeBases |
boolean |
複数のマージベースの警告 |
isDraft |
boolean |
下書き/WIP プル要求。 |
labels |
Web |
pull request に関連付けられているラベル。 |
lastMergeCommit |
Git |
最新の pull request マージのコミット。 空の場合、最新のマージは進行中か、失敗しました。 |
lastMergeSourceCommit |
Git |
最後の pull request マージ時のソース ブランチの先頭にあるコミット。 |
lastMergeTargetCommit |
Git |
最後の pull request マージ時のターゲット ブランチの先頭にあるコミット。 |
mergeFailureMessage |
string |
設定した場合、この理由で pull request のマージに失敗しました。 |
mergeFailureType |
Pull |
pull request マージの失敗の種類 (存在する場合)。 |
mergeId |
string |
pull request マージの実行に使用されるジョブの ID。 内部使用。 |
mergeOptions |
Git |
pull request マージの実行時に使用されるオプション。 完了は 1 回だけ行われ、pull request のソース ブランチが変更されるたびに新しいマージが実行されるため、これらは完了オプションとは別です。 |
mergeStatus |
Pull |
pull request マージの現在の状態。 |
pullRequestId |
integer |
pull request の ID。 |
remoteUrl |
string |
内部使用。 |
repository |
Git |
pull request のターゲット ブランチを含むリポジトリ。 |
reviewers |
Identity |
投票の状態と共に、pull request のレビュー担当者の一覧。 |
sourceRefName |
string |
pull request のソース ブランチの名前。 |
status |
Pull |
pull request の状態。 |
supportsIterations |
boolean |
true の場合、この pull request は複数のイテレーションをサポートします。 イテレーションのサポートは、pull request のソース ブランチへの個々のプッシュを確認できることを意味し、1 回のイテレーションに残されたコメントは、今後のイテレーション全体で追跡されます。 |
targetRefName |
string |
pull request のターゲット ブランチの名前。 |
title |
string |
pull request のタイトル。 |
url |
string |
内部使用。 |
workItemRefs |
Resource |
この pull request に関連付けられているすべての作業項目参照。 |
GitPullRequestCompletionOptions
pull request の完了方法に関する基本設定。
名前 | 型 | 説明 |
---|---|---|
autoCompleteIgnoreConfigIds |
integer[] |
自動完了を待機しないポリシー構成 ID の一覧。 オプションのポリシーにのみ適用されます (isBlocking == false)。 オートコンプリートは常に必要なポリシーを待機します (isBlocking == true)。 |
bypassPolicy |
boolean |
true の場合、プル要求の完了時にポリシーが明示的にバイパスされます。 |
bypassReason |
string |
ポリシーがバイパスされた場合、この理由はバイパスが使用された理由として格納されます。 |
deleteSourceBranch |
boolean |
true の場合、pull request のソース ブランチは完了後に削除されます。 |
mergeCommitMessage |
string |
設定した場合、これはマージ コミットのコミット メッセージとして使用されます。 |
mergeStrategy |
Git |
完了時に pull request をマージするために使用する戦略を指定します。 MergeStrategy が値に設定されていない場合、SquashMerge == false の場合、FF なしのマージが作成されます。 MergeStrategy が値に設定されていない場合、SquashMerge == true の場合、pull request コミットはスカッシュされます。 SquashMerge プロパティは非推奨です。 すべてのケースで MergeStrategy を明示的に設定することをお勧めします。 MergeStrategy に明示的な値が指定されている場合、SquashMerge プロパティは無視されます。 |
squashMerge |
boolean |
スカッシュMerge は非推奨です。 MergeStrategy の値を明示的に設定する必要があります。 MergeStrategy が任意の値に設定されている場合、スカッシュマージ値は無視されます。 MergeStrategy が設定されていない場合、このフラグが false の場合はマージ戦略はfast-forwardされず、true の場合はsquashされます。 |
transitionWorkItems |
boolean |
true の場合、pull request にリンクされている作業項目を次の論理状態 (つまりアクティブ -> 解決済み) に移行しようとします。 |
triggeredByAutoComplete |
boolean |
true の場合、現在の完了試行は自動完了によってトリガーされました。 内部使用。 |
GitPullRequestMergeOptions
pull request マージの作成時に使用されるオプション。
名前 | 型 | 説明 |
---|---|---|
conflictAuthorshipCommits |
boolean |
true の場合、マージ中に適用された競合解決は、git の責任などに関する作成者情報を保持するために、個別のコミットに配置されます。 |
detectRenameFalsePositives |
boolean |
|
disableRenames |
boolean |
true の場合、名前変更の検出はマージ中に実行されません。 |
GitPullRequestMergeStrategy
完了時に pull request をマージするために使用する戦略を指定します。 MergeStrategy が値に設定されていない場合、SquashMerge == false の場合、FF なしのマージが作成されます。 MergeStrategy が値に設定されていない場合、SquashMerge == true の場合、pull request コミットはスカッシュされます。 SquashMerge プロパティは非推奨です。 すべてのケースで MergeStrategy を明示的に設定することをお勧めします。 MergeStrategy に明示的な値が指定されている場合、SquashMerge プロパティは無視されます。
名前 | 型 | 説明 |
---|---|---|
noFastForward |
string |
2 親のfast-forwardマージ。 ソース ブランチは変更されません。 これが既定の動作です。 |
rebase |
string |
ターゲット ブランチの上にソース ブランチをリベースHEADコミットし、ターゲット ブランチをfast-forwardします。 ソース ブランチは、リベース操作中に更新されます。 |
rebaseMerge |
string |
ターゲット ブランチHEADコミットの上にソース ブランチをリベースし、2 親のfast-forwardマージを作成します。 ソース ブランチは、リベース操作中に更新されます。 |
squash |
string |
pull request からのすべての変更を単一親コミットに配置します。 |
GitPushRef
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
REST 参照リンクのコレクションを表す クラス。 |
date |
string |
|
pushId |
integer |
|
pushedBy |
Identity |
|
url |
string |
GitRepository
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
REST 参照リンクのコレクションを表す クラス。 |
defaultBranch |
string |
|
id |
string |
|
isDisabled |
boolean |
True を指定すると、リポジトリが無効になります。 それ以外の場合は false です。 |
isFork |
boolean |
True の 場合は、リポジトリがフォークとして作成されました。 |
isInMaintenance |
boolean |
True の 場合は、リポジトリがメンテナンス中です。 それ以外の場合は false です。 |
name |
string |
|
parentRepository |
Git |
|
project |
Team |
TeamProject への浅い参照を表します。 |
remoteUrl |
string |
|
size |
integer |
リポジトリの圧縮サイズ (バイト)。 |
sshUrl |
string |
|
url |
string |
|
validRemoteUrls |
string[] |
|
webUrl |
string |
GitRepositoryRef
名前 | 型 | 説明 |
---|---|---|
collection |
Team |
このフォークが存在するチーム プロジェクト コレクション |
id |
string |
|
isFork |
boolean |
リポジトリがフォークとして作成された場合は True |
name |
string |
|
project |
Team |
TeamProject への浅い参照を表します。 |
remoteUrl |
string |
|
sshUrl |
string |
|
url |
string |
GitStatus
このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれます。
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
参照リンク。 |
context |
Git |
状態のコンテキスト。 |
createdBy |
Identity |
状態を作成した ID。 |
creationDate |
string |
状態の作成日時。 |
description |
string |
状態の説明。 通常、状態の現在の状態を記述します。 |
id |
integer |
状態識別子。 |
state |
Git |
状態の状態。 |
targetUrl |
string |
状態の詳細を含む URL。 |
updatedDate |
string |
状態の最終更新日時。 |
GitStatusContext
状態を一意に識別する状態コンテキスト。
名前 | 型 | 説明 |
---|---|---|
genre |
string |
状態のジャンル。 通常、状態を生成するサービス/ツールの名前は空にすることができます。 |
name |
string |
状態の名前識別子。null または空にすることはできません。 |
GitStatusState
状態の状態。
名前 | 型 | 説明 |
---|---|---|
error |
string |
エラーが発生した状態。 |
failed |
string |
状態が失敗しました。 |
notApplicable |
string |
状態はターゲット オブジェクトには適用されません。 |
notSet |
string |
状態が設定されていません。 既定の状態です。 |
pending |
string |
状態は保留中です。 |
succeeded |
string |
状態が成功しました。 |
GitTemplate
名前 | 型 | 説明 |
---|---|---|
name |
string |
テンプレートの名前 |
type |
string |
テンプレートの種類 |
GitUserDate
Git 操作のユーザー情報と日付。
名前 | 型 | 説明 |
---|---|---|
date |
string |
Git 操作の日付。 |
string |
git 操作を実行しているユーザーのアドレスをEmailします。 |
|
imageUrl |
string |
ユーザーのアバターの URL。 |
name |
string |
Git 操作を実行しているユーザーの名前。 |
IdentityRef
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。 |
descriptor |
string |
記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。 |
directoryAlias |
string |
非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます |
displayName |
string |
これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。 |
id |
string |
|
imageUrl |
string |
非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます |
inactive |
boolean |
非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます |
isAadIdentity |
boolean |
非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます |
isContainer |
boolean |
非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません |
uniqueName |
string |
非推奨 - 代わりに Domain+PrincipalName を使用します |
url |
string |
この URL は、このグラフの件名のソース リソースへの完全なルートです。 |
IdentityRefWithVote
pull request に対する投票を含む ID 情報。
名前 | 型 | 説明 |
---|---|---|
_links |
Reference |
このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。 |
descriptor |
string |
記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。 |
directoryAlias |
string |
非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます |
displayName |
string |
これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。 |
hasDeclined |
boolean |
このレビュー担当者がこの pull request のレビューを拒否したかどうかを示します。 |
id |
string |
|
imageUrl |
string |
非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます |
inactive |
boolean |
非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます |
isAadIdentity |
boolean |
非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます |
isContainer |
boolean |
非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます |
isDeletedInOrigin |
boolean |
|
isFlagged |
boolean |
この pull request に対してこのレビュー担当者に注意のフラグが設定されているかどうかを示します。 |
isReapprove |
boolean |
投票が変更されなかった場合でも、この承認投票を処理する必要があるかどうかを示します。 |
isRequired |
boolean |
これがこの pull request に必要なレビュー担当者であるかどうかを示します。 |
profileUrl |
string |
非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません |
reviewerUrl |
string |
この ID に関する情報を取得するための URL |
uniqueName |
string |
非推奨 - 代わりに Domain+PrincipalName を使用します |
url |
string |
この URL は、このグラフの件名のソース リソースへの完全なルートです。 |
vote |
integer |
pull request に投票する: |
votedFor |
Identity |
このレビュー担当者が投稿したグループまたはチーム。 |
ItemContent
名前 | 型 | 説明 |
---|---|---|
content |
string |
|
contentType |
Item |
ItemContentType
名前 | 型 | 説明 |
---|---|---|
base64Encoded |
string |
|
rawText |
string |
ProjectState
プロジェクトの状態。
名前 | 型 | 説明 |
---|---|---|
all |
string |
[削除済み] を除く状態に関係なく、すべてのプロジェクト。 |
createPending |
string |
プロジェクトは作成のためにキューに登録されていますが、プロセスはまだ開始されていません。 |
deleted |
string |
プロジェクトが削除されました。 |
deleting |
string |
プロジェクトは削除中です。 |
new |
string |
プロジェクトは作成中です。 |
unchanged |
string |
プロジェクトは変更されていません。 |
wellFormed |
string |
プロジェクトは完全に作成され、使用できる状態になります。 |
ProjectVisibility
プロジェクトの可視性。
名前 | 型 | 説明 |
---|---|---|
private |
string |
プロジェクトは、明示的なアクセス権を持つユーザーにのみ表示されます。 |
public |
string |
プロジェクトはすべてのユーザーに表示されます。 |
PullRequestAsyncStatus
pull request マージの現在の状態。
名前 | 型 | 説明 |
---|---|---|
conflicts |
string |
競合のため、プル要求のマージに失敗しました。 |
failure |
string |
プル要求のマージに失敗しました。 |
notSet |
string |
状態が設定されていません。 既定の状態です。 |
queued |
string |
pull request マージがキューに入れられます。 |
rejectedByPolicy |
string |
ポリシーによって拒否されたプル要求のマージ。 |
succeeded |
string |
Pull request のマージに成功しました。 |
PullRequestMergeFailureType
pull request マージの失敗の種類 (存在する場合)。
名前 | 型 | 説明 |
---|---|---|
caseSensitive |
string |
大文字と小文字の不一致が原因で、Pull request のマージに失敗しました。 |
none |
string |
型が設定されていません。 既定の型。 |
objectTooLarge |
string |
オブジェクトが大きすぎるため、プル要求のマージに失敗しました。 |
unknown |
string |
Pull request マージ エラーの種類が不明です。 |
PullRequestStatus
pull request の状態。
名前 | 型 | 説明 |
---|---|---|
abandoned |
string |
pull request は破棄されます。 |
active |
string |
Pull request がアクティブです。 |
all |
string |
pull request 検索条件で使用され、すべての状態が含まれます。 |
completed |
string |
pull request が完了しました。 |
notSet |
string |
状態が設定されていません。 既定の状態です。 |
ReferenceLinks
REST 参照リンクのコレクションを表す クラス。
名前 | 型 | 説明 |
---|---|---|
links |
object |
リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。 |
ResourceRef
名前 | 型 | 説明 |
---|---|---|
id |
string |
|
url |
string |
TeamProjectCollectionReference
TeamProjectCollection の参照オブジェクト。
名前 | 型 | 説明 |
---|---|---|
avatarUrl |
string |
コレクションアバターの URL。 |
id |
string |
コレクション ID。 |
name |
string |
コレクション名。 |
url |
string |
コレクション REST URL。 |
TeamProjectReference
TeamProject への浅い参照を表します。
名前 | 型 | 説明 |
---|---|---|
abbreviation |
string |
プロジェクトの省略形。 |
defaultTeamImageUrl |
string |
既定のチーム ID イメージへの URL。 |
description |
string |
プロジェクトの説明 (存在する場合)。 |
id |
string |
プロジェクト識別子。 |
lastUpdateTime |
string |
プロジェクトの最終更新時刻。 |
name |
string |
プロジェクト名。 |
revision |
integer |
プロジェクトリビジョン。 |
state |
Project |
プロジェクトの状態。 |
url |
string |
オブジェクトの完全なバージョンへの URL。 |
visibility |
Project |
プロジェクトの可視性。 |
VersionControlChangeType
アイテムに対して行われた変更の種類。
名前 | 型 | 説明 |
---|---|---|
add |
string |
|
all |
string |
|
branch |
string |
|
delete |
string |
|
edit |
string |
|
encoding |
string |
|
lock |
string |
|
merge |
string |
|
none |
string |
|
property |
string |
|
rename |
string |
|
rollback |
string |
|
sourceRename |
string |
|
targetRename |
string |
|
undelete |
string |
WebApiTagDefinition
ワイヤを介して送信されるタグ定義の表現。
名前 | 型 | 説明 |
---|---|---|
active |
boolean |
タグ定義がアクティブかどうか。 |
id |
string |
タグ定義の ID。 |
name |
string |
タグ定義の名前。 |
url |
string |
タグ定義のリソース URL。 |