共用方式為


Runs - Create

建立新的測試回合。

POST https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=7.1-preview.3

URI 參數

名稱 位於 必要 類型 Description
organization
path True

string

Azure DevOps 組織的名稱。

project
path True

string

專案識別碼或專案名稱

api-version
query True

string

要使用的 API 版本。 這應該設定為 '7.1-preview.3',以使用此版本的 API。

要求本文

名稱 類型 Description
automated

boolean

如果測試回合是自動化的,則為 true,否則為 false。 根據預設,它會是 false。

build

ShallowReference

其所屬組建的抽象參考。

buildDropLocation

string

卸載用於測試回合的組建位置。

buildFlavor

string

用於測試回合的組建類別。 (例如:發行、偵錯)

buildPlatform

string

用於測試回合的組建平臺。 (例如:x86、amd64)

buildReference

BuildConfiguration

測試回合的 BuildReference。

comment

string

分析回合的批註所輸入的批註。

completeDate

string

執行完成的日期時間。

configurationIds

integer[]

與執行相關聯的測試組態識別碼。

controller

string

用於自動化執行的測試控制器名稱。

customTestFields

CustomTestField[]

測試回合的其他屬性。

dtlAutEnvironment

ShallowReference

DtlAutEnvironment 的抽象參考。

dtlTestEnvironment

ShallowReference

DtlTestEnvironment 的抽象參考。

dueDate

string

測試回合的到期日期和時間。

environmentDetails

DtlEnvironmentDetails

這是暫存類別,可提供測試回合環境的詳細資料。

errorMessage

string

與執行相關聯的錯誤訊息。

filter

RunFilter

用於探索執行的篩選準則。

iteration

string

要在其中建立執行的反復專案。 小組專案的根反復專案預設為預設值

name

string

測試回合的名稱。

owner

IdentityRef

執行之擁有者的顯示名稱。

pipelineReference

PipelineReference

這個測試回合所屬管線的參考。 PipelineReference.PipelineId 應該等於 RunCreateModel.Build.Id

plan

ShallowReference

其所屬計畫的抽象參考。

pointIds

integer[]

執行中要使用的測試點識別碼。

releaseEnvironmentUri

string

與執行相關聯的發行環境 URI。

releaseReference

ReleaseReference

與測試回合相關聯的發行參考。

releaseUri

string

與執行相關聯的發行 URI。

runSummary

RunSummaryModel[]

執行類型 = NoConfigRun 的執行摘要。

runTimeout

string

直到執行時間逾時為止。

sourceWorkflow

string

SourceWorkFlow (測試回合的 CI/CD) 。

startDate

string

執行的開始日期時間。

state

string

執行的狀態。 輸入 TestRunState 有效狀態 - NotStarted、InProgress、Waiting

tags

TestTag[]

要附加測試回合的標記,最多可以新增 5 個標記來執行。

testConfigurationsMapping

string

測試回合的 TestConfigurationMapping。

testEnvironmentId

string

與執行相關聯的測試環境識別碼。

testSettings

ShallowReference

測試設定資源的抽象參考。

type

string

執行類型 (RunType) 有效值: (未指定、標準、封鎖、Web、MtrRunInitiatedFromWeb、RunWithDtlEnv、NoConfigRun)

回應

名稱 類型 Description
200 OK

TestRun

成功作業

安全性

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

名稱 Description
vso.test_write 授與讀取、建立及更新測試計劃、案例、結果和其他測試管理相關成品的能力。

範例

Sample Request

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs?api-version=7.1-preview.3

{
  "name": "NewTestRun",
  "plan": {
    "id": "1"
  },
  "pointIds": [
    1,
    1
  ]
}

Sample Response

{
  "id": 31,
  "name": "NewTestRun",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/31",
  "isAutomated": false,
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
  "owner": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "startedDate": "2014-05-28T16:39:00.44Z",
  "state": "InProgress",
  "plan": {
    "id": "1",
    "name": "sprint1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "postProcessState": "Complete",
  "totalTests": 2,
  "incompleteTests": 2,
  "createdDate": "2014-05-28T16:39:00.4Z",
  "lastUpdatedDate": "2014-05-28T16:39:00.44Z",
  "lastUpdatedBy": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "revision": 2
}

定義

名稱 Description
BuildConfiguration

BuildConfiguration 詳細資料。

CustomTestField

自訂欄位資訊。 允許的索引鍵:值組 - ( AttemptId:int 值、IsTestResultFlaky:bool)

DtlEnvironmentDetails

這是暫存類別,可提供測試回合環境的詳細資料。

IdentityRef
JobReference

管線中的作業。 這與 YAML 中的矩陣相關。

PhaseReference

管線中的階段

PipelineReference

管線參考

ReferenceLinks

表示 REST 參考連結集合的類別。

ReleaseReference

發行的參考。

ResultMetadata

指定結果/計數的 ResultMetadata。

RunCreateModel

測試回合建立詳細資料。

RunFilter

這個類別可用來提供用於探索的篩選

RunStatistic

測試每個結果的執行統計資料。

RunSummaryModel

每個測試輸出類型的執行摘要。

ShallowReference

其他資源的抽象參考。 這個類別是用來提供建置資料合約的統一方式,以參考其他資源的方式,以提供輕鬆的周遊連結。

StageReference

管線中的階段

TestEnvironment

測試環境詳細資料。

TestOutcome
TestResolutionState

測試解析狀態詳細資料。

TestRun

測試回合詳細資料。

TestRunSubstate

測試回合的子狀態類型。

TestTag

附加至執行或結果的標記。

BuildConfiguration

BuildConfiguration 詳細資料。

名稱 類型 Description
branchName

string

產生組建的分支名稱。

buildDefinitionId

integer

BuildDefinitionId 用於建置。

buildSystem

string

建置系統。

creationDate

string

組建建立日期。

flavor

string

組建類別 (例如組建/發行) 。

id

integer

BuildConfiguration 識別碼。

number

string

組建編號。

platform

string

BuildConfiguration Platform。

project

ShallowReference

與此 BuildConfiguration 相關聯的專案。

repositoryGuid

string

組建的存放庫 Guid。

repositoryType

string

存放庫類型 (例如TFSGit) 。

sourceVersion

string

已觸發組建的來源版本 (/first 認可) 。

targetBranchName

string

目標 BranchName。

uri

string

建置 URI。

CustomTestField

自訂欄位資訊。 允許的索引鍵:值組 - ( AttemptId:int 值、IsTestResultFlaky:bool)

名稱 類型 Description
fieldName

string

欄位名稱。

value

object

域值。

DtlEnvironmentDetails

這是暫存類別,可提供測試回合環境的詳細資料。

名稱 類型 Description
csmContent

string

csmParameters

string

subscriptionName

string

IdentityRef

名稱 類型 Description
_links

ReferenceLinks

此欄位包含圖表主旨的相關零或更多有趣連結。 您可以叫用這些連結來取得其他關聯性,或取得此圖表主體的詳細資訊。

descriptor

string

描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。

directoryAlias

string

已被取代 - 您可以藉由查詢 IdentityRef 「_links」 字典的 「self」 專案中參考的 Graph 使用者來擷取

displayName

string

這是圖形主體的非唯一顯示名稱。 若要變更此欄位,您必須變更來源提供者中的值。

id

string

imageUrl

string

已淘汰 - 可在 IdentityRef 「_links」 字典的 「avatar」 專案中使用

inactive

boolean

已被取代 - 您可以藉由查詢 GraphUser 「_links」 字典的 「membershipState」 專案中所參考的 Graph 成員資格狀態來擷取

isAadIdentity

boolean

已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

已被取代 - 不在 ToIdentityRef 的大部分預先存在實作中使用

uniqueName

string

已被取代 - 請改用 Domain+PrincipalName

url

string

此 URL 是此圖形主體來源資源的完整路由。

JobReference

管線中的作業。 這與 YAML 中的矩陣相關。

名稱 類型 Description
attempt

integer

嘗試作業數目

jobName

string

YAML 中的矩陣會產生具有矩陣中不同輸入之作業的複本。 JobName 是這些輸入的名稱。 名稱支援的長度上限為 256 個字元。

PhaseReference

管線中的階段

名稱 類型 Description
attempt

integer

嘗試階段數目

phaseName

string

階段的名稱。 名稱支援的長度上限為 256 個字元。

PipelineReference

管線參考

名稱 類型 Description
jobReference

JobReference

作業的參考

phaseReference

PhaseReference

階段的參考。

pipelineId

integer

與此管線實例相關的管線參考。

stageReference

StageReference

階段的參考。

表示 REST 參考連結集合的類別。

名稱 類型 Description
links

object

連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。

ReleaseReference

發行的參考。

名稱 類型 Description
attempt

integer

發行嘗試次數。

creationDate

string

發行建立日期 (UTC) 。

definitionId

integer

發行定義識別碼。

environmentCreationDate

string

環境建立日期 (UTC) 。

environmentDefinitionId

integer

發行環境定義識別碼。

environmentDefinitionName

string

發行環境定義名稱。

environmentId

integer

發行環境識別碼。

environmentName

string

發行環境名稱。

id

integer

版本識別碼。

name

string

發行版本名稱。

ResultMetadata

指定結果/計數的 ResultMetadata。

名稱 類型 Description
flaky

string

Flaky 中繼資料

rerun

string

重新執行中繼資料

RunCreateModel

測試回合建立詳細資料。

名稱 類型 Description
automated

boolean

如果測試回合是自動化的,則為 true,否則為 false。 根據預設,它會是 false。

build

ShallowReference

其所屬組建的抽象參考。

buildDropLocation

string

卸載用於測試回合的組建位置。

buildFlavor

string

用於測試回合的組建類別。 (例如:發行、偵錯)

buildPlatform

string

用於測試回合的組建平臺。 (例如:x86、amd64)

buildReference

BuildConfiguration

測試回合的 BuildReference。

comment

string

分析執行時所輸入的批註。

completeDate

string

執行完成的日期時間。

configurationIds

integer[]

與回合相關聯的測試組態識別碼。

controller

string

用於自動化執行的測試控制器名稱。

customTestFields

CustomTestField[]

測試回合的其他屬性。

dtlAutEnvironment

ShallowReference

DtlAutEnvironment 的抽象參考。

dtlTestEnvironment

ShallowReference

DtlTestEnvironment 的抽象參考。

dueDate

string

測試回合的到期日期和時間。

environmentDetails

DtlEnvironmentDetails

這是暫存類別,可提供測試回合環境的詳細資料。

errorMessage

string

與執行相關聯的錯誤訊息。

filter

RunFilter

用於探索執行的篩選準則。

iteration

string

要在其中建立執行的反復專案。 Team 專案的根反復專案預設為

name

string

測試回合的名稱。

owner

IdentityRef

執行之擁有者的顯示名稱。

pipelineReference

PipelineReference

這個測試回合所屬之管線的參考。 PipelineReference.PipelineId 應等於 RunCreateModel.Build.Id

plan

ShallowReference

其所屬計畫的抽象參考。

pointIds

integer[]

執行中要使用的測試點識別碼。

releaseEnvironmentUri

string

與執行相關聯的發行環境 URI。

releaseReference

ReleaseReference

與測試回合相關聯的發行參考。

releaseUri

string

與執行相關聯的發行 URI。

runSummary

RunSummaryModel[]

執行類型 = NoConfigRun 的執行摘要。

runTimeout

string

運行時間範圍直到逾時為止。

sourceWorkflow

string

SourceWorkFlow (測試回合的 CI/CD) 。

startDate

string

執行的開始日期時間。

state

string

執行的狀態。 類型 TestRunState 有效狀態 - NotStarted、InProgress、Waiting

tags

TestTag[]

要附加測試回合的標記,最多可以新增 5 個標記來執行。

testConfigurationsMapping

string

測試回合的 TestConfigurationMapping。

testEnvironmentId

string

與回合相關聯的測試環境識別碼。

testSettings

ShallowReference

測試設定資源的抽象參考。

type

string

run (RunType) 有效值的類型: (Unspecified、Normal、Blocking、Web、MtrRunInitiatedFromWeb、RunWithDtlEnv、NoConfigRun)

RunFilter

這個類別可用來提供用於探索的篩選

名稱 類型 Description
sourceFilter

string

測試案例來源篩選 (測試容器)

testCaseFilter

string

測試案例的篩選

RunStatistic

測試每個結果的執行統計資料。

名稱 類型 Description
count

integer

給定結果的測試結果計數。

outcome

string

測試結果結果

resolutionState

TestResolutionState

測試回合解析狀態。

resultMetadata

ResultMetadata

指定結果/計數的 ResultMetadata。

state

string

測試回合的狀態

RunSummaryModel

每個測試輸出類型的執行摘要。

名稱 類型 Description
duration

integer

以毫秒為單位所花費的總時間。

resultCount

integer

結果 TestOutcome 的結果數目

testOutcome

TestOutcome

摘要是以結果為基礎

ShallowReference

其他資源的抽象參考。 這個類別是用來提供建置資料合約的統一方式,以參考其他資源的方式,以提供輕鬆的周遊連結。

名稱 類型 Description
id

string

資源的識別碼

name

string

連結資源的名稱 (定義名稱、控制器名稱等。)

url

string

資源的完整 HTTP 連結

StageReference

管線中的階段

名稱 類型 Description
attempt

integer

嘗試階段數目

stageName

string

階段的名稱。 名稱支援的長度上限為 256 個字元。

TestEnvironment

測試環境詳細資料。

名稱 類型 Description
environmentId

string

測試環境識別碼。

environmentName

string

測試環境名稱。

TestOutcome

名稱 類型 Description
aborted

string

測試已中止。 這不是由使用者手勢所造成,而是由架構決策所造成。

blocked

string

測試有機會執行,但不是,因為 ITestElement.IsRunnable == false。

error

string

嘗試執行測試時發生系統錯誤。

failed

string

測試已執行,但發生問題。 問題可能涉及例外狀況或失敗的判斷提示。

inProgress

string

測試目前正在執行。 針對 TCM 圖表新增此專案

inconclusive

string

測試已完成,但我們無法說是否已通過或失敗。 可用於中止的測試...

none

string

測試尚未完成,或測試類型未報告通過/失敗。

notApplicable

string

測試不適用於執行。

notExecuted

string

未執行測試。 這是因為使用者手勢所造成,例如使用者按下 [停止] 按鈕。

notImpacted

string

測試不會受到影響。 已新增 fot TIA。

passed

string

測試執行時發生任何問題。

paused

string

測試已暫停。

timeout

string

測試逾時

unspecified

string

只在更新期間使用,才能保留現有的值。

warning

string

若要供執行層級結果使用。 這不是失敗。

TestResolutionState

測試解析狀態詳細資料。

名稱 類型 Description
id

integer

測試解析狀態識別碼。

name

string

測試解析狀態名稱。

project

ShallowReference

其他資源的抽象參考。 這個類別是用來提供建置資料合約的統一方式,以參考其他資源的方式,以提供輕鬆的周遊連結。

TestRun

測試回合詳細資料。

名稱 類型 Description
build

ShallowReference

與此測試回合相關聯的組建。

buildConfiguration

BuildConfiguration

建置與此測試回合相關聯的組態詳細資料。

comment

string

分析回合的批註所輸入的批註。

completedDate

string

執行完成的日期時間。

controller

string

測試回合控制器。

createdDate

string

測試回合 CreatedDate。

customFields

CustomTestField[]

TestRun 的自訂欄位清單。

dropLocation

string

卸載測試回合的位置。

dtlAutEnvironment

ShallowReference

其他資源的抽象參考。 這個類別是用來提供建置資料合約的統一方式,以參考其他資源的方式,以提供輕鬆的周遊連結。

dtlEnvironment

ShallowReference

其他資源的抽象參考。 這個類別是用來提供建置資料合約的統一方式,以參考其他資源的方式,以提供輕鬆的周遊連結。

dtlEnvironmentCreationDetails

DtlEnvironmentDetails

這是暫存類別,可提供測試回合環境的詳細資料。

dueDate

string

測試回合的到期日期和時間。

errorMessage

string

與執行相關聯的錯誤訊息。

filter

RunFilter

這個類別可用來提供用於探索的篩選

id

integer

測試回合的識別碼。

incompleteTests

integer

未完成的測試數目。

isAutomated

boolean

如果測試回合是自動化的,則為 true,否則為 false。

iteration

string

執行所屬的反復專案。

lastUpdatedBy

IdentityRef

上次更新測試回合的小組基礎識別碼。

lastUpdatedDate

string

上次更新的日期和時間

name

string

測試回合的名稱。

notApplicableTests

integer

不適用的測試數目。

owner

IdentityRef

執行擁有者的 Team Foundation 識別碼。

passedTests

integer

執行中通過的測試數目

phase

string

testRun 的階段/狀態。

pipelineReference

PipelineReference

這個測試回合所屬管線的參考。

plan

ShallowReference

與此測試回合相關聯的測試計劃。

postProcessState

string

後續處理狀態。

project

ShallowReference

與此回合相關聯的專案。

release

ReleaseReference

測試回合的版本參考。

releaseEnvironmentUri

string

TestRun 的版本環境 URI。

releaseUri

string

TestRun 的版本 URI。

revision

integer

runStatistics

RunStatistic[]

依結果執行 RunSummary。

startedDate

string

執行的開始日期時間。

state

string

執行的狀態。 類型 TestRunState 有效狀態 - 未指定、NotStarted、InProgress、Completed、Waiting、Aborted、NeedsInvestigation

substate

TestRunSubstate

TestRun Substate。

tags

TestTag[]

附加在此測試回合的標記。

testEnvironment

TestEnvironment

與回合相關聯的測試環境。

testMessageLogId

integer

testSettings

ShallowReference

一些其他資源的抽象參考。 這個類別可用來提供建置資料合約,以統一方式參考其他資源,以提供輕鬆周遊連結的方式。

totalTests

integer

回合中的測試總數

unanalyzedTests

integer

執行中失敗的測試數目。

url

string

測試回合的 URL

webAccessUrl

string

TestRun 的 Web 存取 URL。

TestRunSubstate

測試回合的子狀態類型。

名稱 類型 Description
abortedBySystem

string

當系統中止時執行狀態。

analyzed

string

在分析之後執行狀態。

canceledByUser

string

建立環境時執行狀態。

cancellationInProgress

string

取消正在進行時執行狀態。

creatingEnvironment

string

建立環境時執行狀態。

none

string

使用 noState 執行。

pendingAnalysis

string

暫止分析時執行狀態。

runningTests

string

執行測試時執行狀態。

timedOut

string

執行時間有 timedOut 時執行狀態。

TestTag

附加至執行或結果的標記。

名稱 類型 Description
name

string

標記的名稱,英數位元值小於 30 個字元