Sdílet prostřednictvím


TestRestClient class

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

Konstruktory

TestRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)

Přidejte testovací případy do sady.

addTestResultsToTestRun(TestCaseResult[], string, number)

Přidejte výsledky testů do testovacího spuštění.

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Připojení souboru k výsledku testovacího kroku

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Připojte soubor k výsledku testu.

createTestRun(RunCreateModel, string)

Vytvořte nové testovací spuštění.

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Připojte soubor k testovacímu spuštění.

createTestSession(TestSession, TeamContext)

Vytvoření testovací relace

createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Připojení souboru k výsledku testu

deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)

Odstraňte testovací případ.

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)

Odstraňte testovací běh podle jeho ID.

deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)

Získejte data pokrytí kódu pro sestavení.

getCodeCoverageSummary(string, number, number)

Získejte souhrn pokrytí kódu pro sestavení.

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)

Získejte testovací bod.

getPoints(string, number, number, string, string, string, string, boolean, number, number)

Získejte seznam testovacích bodů.

getPointsByQuery(TestPointsQuery, string, number, number)

Získání testovacích bodů pomocí dotazu

getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)

Získání nastavení uchovávání výsledků testu

getTestCaseById(string, number, number, number)

Získejte konkrétní testovací případ v testovací sadě s ID testovacího případu.

getTestCases(string, number, number)

Získejte všechny testovací případy v sadě.

getTestIteration(string, number, number, number, boolean)

Získání iterace výsledku

getTestIterations(string, number, number, boolean)

Získání iterací pro výsledek

getTestResultAttachmentContent(string, number, number, number)

Stáhněte přílohu výsledků testu podle id testu.

getTestResultAttachments(string, number, number)

Získejte seznam odkazů na přílohy výsledků testu.

getTestResultAttachmentZip(string, number, number, number)

Stáhněte přílohu výsledků testu podle id testu.

getTestResultById(string, number, number, ResultDetails)

Získejte výsledek testu pro testovací běh.

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])

Získejte výsledky testu pro testovací běh.

getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)

Toto rozhraní API vrátí výsledky podle ID s poli zadanými nebo trendem pro konkrétní automatizovanou testovací metodu. Toto rozhraní API stále vylepšujeme a nedokon čteme správný podpis a kontrakt.

getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)

Stáhněte přílohu testovacího spuštění podle ID.

getTestRunAttachments(string, number)

Získejte seznam odkazů na přílohy testovacího spuštění.

getTestRunAttachmentZip(string, number, number)

Stáhněte přílohu testovacího spuštění podle ID.

getTestRunById(string, number, boolean)

Získejte testovací spuštění podle ID.

getTestRunCodeCoverage(string, number, number)

Získání dat pokrytí kódu pro testovací běh

getTestRunLogs(string, number)

Získání protokolů zpráv o testovacím spuštění

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

Získejte seznam testovacích běhů.

getTestRunStatistics(string, number)

Získejte statistiku testovacího běhu , která se používá, když chceme získat souhrn spuštění podle výsledku.

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

Získání seznamu testovacích relací

getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)

Stažení přílohy výsledků testu

getTestSubResultAttachments(string, number, number, number)

Získání seznamu příloh dílčích výsledků testu

getTestSubResultAttachmentZip(string, number, number, number, number)

Stažení přílohy výsledků testu

processSuitesForStaging(StagedSuitesRequestModel, string, number)

Zpracuje kolekci testovacích sad a vrátí model odpovědí obsahující podrobnosti o sadě a testovacím případu.

publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)

Získání historie testovací metody pomocí TestHistoryQuery

queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)

Získání seznamu podrobností metadat výsledku testu pro odpovídající id testcasereferenceId

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)

Dotazování testovacích běhů na základě filtrů Povinná pole jsou minLastUpdatedDate a maxLastUpdatedDate.

queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)

Testovací body přidružené k testovacím případům se z testovací sady odeberou. Pracovní položka testovacího případu se ze systému neodstraní. Pokud chcete trvale odstranit testovací případ, podívejte se na prostředek testovacích případů.

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Požadavek: Souhrn pokrytí kódu ve formátu JSON

updateResultRetentionSettings(ResultRetentionSettings, string)

Aktualizace nastavení uchovávání výsledků testu

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

Aktualizuje vlastnosti přidružení testovacího případu v sadě.

updateTestPoints(PointUpdateModel, string, number, number, string)

Aktualizujte testovací body.

updateTestResults(TestCaseResult[], string, number)

Aktualizace výsledků testu při testovacím spuštění

updateTestRun(RunUpdateModel, string, number)

Aktualizujte testovací běh podle ID.

updateTestSession(TestSession, TeamContext)

Aktualizace testovací relace

Podrobnosti konstruktoru

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Parametry

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addCustomFields(CustomTestFieldDefinition[], string)

function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>

Parametry

project

string

ID projektu nebo název projektu

Návraty

addTestCasesToSuite(string, number, number, string)

Přidejte testovací případy do sady.

function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

Parametry

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu, který obsahuje sadu.

suiteId

number

ID sady testů, do které musí být přidány testovací případy.

testCaseIds

string

ID testovacích případů, které se mají přidat do sady ID jsou zadána ve formátu odděleném čárkami.

Návraty

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Přidejte výsledky testů do testovacího spuštění.

function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametry

results

TestCaseResult[]

Seznam výsledků testů, které chcete přidat

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, do kterého se mají výsledky testu přidat.

Návraty

Promise<TestCaseResult[]>

function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>

Parametry

workItemToTestLinks
WorkItemToTestLinks
project

string

ID projektu nebo název projektu

Návraty

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Připojení souboru k výsledku testovacího kroku

function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel
TestAttachmentRequestModel

Podrobnosti přílohy TestAttachmentRequestModel

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledku testu, který obsahuje iteraci

iterationId

number

ID iterace výsledků testu

actionPath

string

Šestnáctkové hodnoty cesty akce výsledku testu.

Návraty

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Připojte soubor k výsledku testu.

function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel
TestAttachmentRequestModel

Podrobnosti přílohy TestAttachmentRequestModel

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledku testu, do kterého musí být nahrány přílohy.

Návraty

createTestRun(RunCreateModel, string)

Vytvořte nové testovací spuštění.

function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>

Parametry

testRun
RunCreateModel

Spuštění podrobností RunCreateModel

project

string

ID projektu nebo název projektu

Návraty

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Připojte soubor k testovacímu spuštění.

function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel
TestAttachmentRequestModel

Podrobnosti přílohy TestAttachmentRequestModel

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, do kterého musí být nahrány přílohy.

Návraty

createTestSession(TestSession, TeamContext)

Vytvoření testovací relace

function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

Parametry

testSession
TestSession

Podrobnosti o testovací relaci pro vytvoření

teamContext
TeamContext

Kontext týmu pro operaci

Návraty

Promise<TestSession>

createTestSettings(TestSettings, string)

function createTestSettings(testSettings: TestSettings, project: string): Promise<number>

Parametry

testSettings
TestSettings
project

string

ID projektu nebo název projektu

Návraty

Promise<number>

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Připojení souboru k výsledku testu

function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel
TestAttachmentRequestModel

Model žádosti o přílohu

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledků testu, které obsahují dílčí výsledek.

testSubResultId

number

ID testovacích dílčích výsledků, do kterých se příloha musí nahrát.

Návraty

deleteSharedParameter(string, number)

function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

sharedParameterId

number

Návraty

Promise<void>

deleteSharedStep(string, number)

function deleteSharedStep(project: string, sharedStepId: number): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

sharedStepId

number

Návraty

Promise<void>

deleteTestCase(string, number)

Odstraňte testovací případ.

function deleteTestCase(project: string, testCaseId: number): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

testCaseId

number

ID testovacího případu, který chcete odstranit.

Návraty

Promise<void>

function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>

Parametry

project

string

ID projektu nebo název projektu

testName

string

workItemId

number

Návraty

Promise<boolean>

deleteTestRun(string, number)

Odstraňte testovací běh podle jeho ID.

function deleteTestRun(project: string, runId: number): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID spuštění, které chcete odstranit.

Návraty

Promise<void>

deleteTestSettings(string, number)

function deleteTestSettings(project: string, testSettingsId: number): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

testSettingsId

number

Návraty

Promise<void>

getBugsLinkedToTestResult(string, number, number)

function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

testCaseResultId

number

Návraty

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Získejte data pokrytí kódu pro sestavení.

function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>

Parametry

project

string

ID projektu nebo název projektu

buildId

number

ID sestavení, pro které je potřeba načíst data pokrytí kódu.

flags

number

Hodnota příznaků určuje úroveň podrobností pokrytí kódu, které se mají načíst. Příznaky jsou doplňkové. Očekávané hodnoty jsou 1 pro moduly, 2 pro functions, 4 pro BlockData.

Návraty

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Získejte souhrn pokrytí kódu pro sestavení.

function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>

Parametry

project

string

ID projektu nebo název projektu

buildId

number

ID sestavení, pro které je potřeba načíst data pokrytí kódu.

deltaBuildId

number

ID sestavení Delta (volitelné)

Návraty

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>

Parametry

workItemQuery
LinkedWorkItemsQuery
project

string

ID projektu nebo název projektu

Návraty

getPoint(string, number, number, number, string)

Získejte testovací bod.

function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>

Parametry

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu.

suiteId

number

ID sady, která obsahuje bod.

pointIds

number

ID testovacího bodu, který chcete získat.

witFields

string

Čárkami oddělený seznam názvů polí pracovních položek

Návraty

Promise<TestPoint>

getPoints(string, number, number, string, string, string, string, boolean, number, number)

Získejte seznam testovacích bodů.

function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>

Parametry

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu.

suiteId

number

ID sady, která obsahuje body.

witFields

string

Čárkami oddělený seznam názvů polí pracovních položek

configurationId

string

Získejte testovací body pro konkrétní konfiguraci.

testCaseId

string

Získejte testovací body pro konkrétní testovací případ, platný, pokud není nastaven parametr configurationId.

testPointIds

string

Získejte testovací body pro seznam ID testovacích bodů oddělených čárkami, platný pouze v případě, že není nastaven parametr configurationId a testCaseId.

includePointDetails

boolean

Zahrňte všechny vlastnosti testovacího bodu.

skip

number

Počet testovacích bodů, které se mají přeskočit.

top

number

Počet testovacích bodů, které se mají vrátit.

Návraty

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Získání testovacích bodů pomocí dotazu

function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>

Parametry

query
TestPointsQuery

TestPointsQuery pro získání testovacích bodů

project

string

ID projektu nebo název projektu

skip

number

Počet testovacích bodů, které se mají přeskočit.

top

number

Počet testovacích bodů, které se mají vrátit.

Návraty

Promise<TestPointsQuery>

getResultGroupsByBuild(string, number, string, string[], string)

function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Parametry

project

string

ID projektu nebo název projektu

buildId

number

publishContext

string

fields

string[]

continuationToken

string

Návraty

getResultGroupsByRelease(string, number, string, number, string[], string)

function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Parametry

project

string

ID projektu nebo název projektu

releaseId

number

publishContext

string

releaseEnvId

number

fields

string[]

continuationToken

string

Návraty

getResultRetentionSettings(string)

Získání nastavení uchovávání výsledků testu

function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>

Parametry

project

string

ID projektu nebo název projektu

Návraty

getTestCaseById(string, number, number, number)

Získejte konkrétní testovací případ v testovací sadě s ID testovacího případu.

function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>

Parametry

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu, který obsahuje sady.

suiteId

number

ID sady, která obsahuje testovací případ.

testCaseIds

number

ID testovacího případu, který chcete získat.

Návraty

Promise<SuiteTestCase>

getTestCases(string, number, number)

Získejte všechny testovací případy v sadě.

function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>

Parametry

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu, který obsahuje sady.

suiteId

number

ID sady, která se má získat.

Návraty

Promise<SuiteTestCase[]>

getTestIteration(string, number, number, number, boolean)

Získání iterace výsledku

function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledku testu, který obsahuje iterace.

iterationId

number

ID iterace výsledků testu

includeActionResults

boolean

Zahrňte podrobnosti o výsledku pro každou akci provedenou v iteraci testu. ActionResults odkazuje na výsledek (pass/fail) testovacích kroků, které se provádějí jako součást spuštění ručního testu. Zahrnutí příznaku ActionResults získá výsledek testovacích kroků v části actionResults a parametry testu v oddílu parametrů pro každou iteraci testů.

Návraty

getTestIterations(string, number, number, boolean)

Získání iterací pro výsledek

function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledku testu, který obsahuje iterace.

includeActionResults

boolean

Zahrňte podrobnosti o výsledku pro každou akci provedenou v iteraci testu. ActionResults odkazuje na výsledek (pass/fail) testovacích kroků, které se provádějí jako součást spuštění ručního testu. Zahrnutí příznaku ActionResults získá výsledek testovacích kroků v části actionResults a parametry testu v oddílu parametrů pro každou iteraci testů.

Návraty

getTestResultAttachmentContent(string, number, number, number)

Stáhněte přílohu výsledků testu podle id testu.

function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje testCaseResultId.

testCaseResultId

number

ID výsledku testu, jehož příloha se musí stáhnout.

attachmentId

number

ID přílohy výsledků testu, kterou chcete stáhnout.

Návraty

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Získejte seznam odkazů na přílohy výsledků testu.

function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledku testu.

Návraty

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Stáhněte přílohu výsledků testu podle id testu.

function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje testCaseResultId.

testCaseResultId

number

ID výsledku testu, jehož příloha se musí stáhnout.

attachmentId

number

ID přílohy výsledků testu, kterou chcete stáhnout.

Návraty

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Získejte výsledek testu pro testovací běh.

function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění výsledku testu, který se má načíst.

testCaseResultId

number

ID výsledku testu.

detailsToInclude
ResultDetails

Podrobnosti, které se mají zahrnout do výsledků testů. Výchozí hodnota není Žádná. Další hodnoty jsou Iterace, WorkItems a SubResults.

Návraty

Promise<TestCaseResult>

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)

function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametry

project

string

ID projektu nebo název projektu

buildId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

Návraty

getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)

function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametry

project

string

ID projektu nebo název projektu

releaseId

number

releaseEnvId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

Návraty

getTestResults(string, number, ResultDetails, number, number, TestOutcome[])

Získejte výsledky testu pro testovací běh.

function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění výsledků testu, které se mají načíst.

detailsToInclude
ResultDetails

Podrobnosti, které se mají zahrnout do výsledků testů. Výchozí hodnota není Žádná. Další hodnoty jsou Iterace a WorkItems.

skip

number

Počet výsledků testu, které se mají přeskočit od začátku

top

number

Počet výsledků testu, které se mají vrátit Maximum je 1000, pokud podrobnostiToInclude je None a 200 jinak.

outcomes

TestOutcome[]

Čárkami oddělený seznam výsledků testů pro filtrování výsledků testů

Návraty

Promise<TestCaseResult[]>

getTestResultsByBuild(string, number, string, TestOutcome[], number, string)

function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Parametry

project

string

ID projektu nebo název projektu

buildId

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

Návraty

getTestResultsByQuery(TestResultsQuery, string)

Toto rozhraní API vrátí výsledky podle ID s poli zadanými nebo trendem pro konkrétní automatizovanou testovací metodu. Toto rozhraní API stále vylepšujeme a nedokon čteme správný podpis a kontrakt.

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>

Parametry

project

string

ID projektu nebo název projektu

Návraty

Promise<TestResultsQuery>

getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)

function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Parametry

project

string

ID projektu nebo název projektu

releaseId

number

releaseEnvid

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

Návraty

getTestRunAttachmentContent(string, number, number)

Stáhněte přílohu testovacího spuštění podle ID.

function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, jehož příloha se musí stáhnout.

attachmentId

number

ID přílohy testovacího spuštění, která se má stáhnout.

Návraty

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Získejte seznam odkazů na přílohy testovacího spuštění.

function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění.

Návraty

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Stáhněte přílohu testovacího spuštění podle ID.

function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, jehož příloha se musí stáhnout.

attachmentId

number

ID přílohy testovacího spuštění, která se má stáhnout.

Návraty

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Získejte testovací spuštění podle ID.

function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID spuštění, které chcete získat.

includeDetails

boolean

Výchozí hodnota je true. Obsahuje podrobnosti, jako jsou statistiky spuštění, vydání, sestavení, testovací prostředí, stav po procesu a další.

Návraty

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Získání dat pokrytí kódu pro testovací běh

function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, pro které je potřeba načíst data pokrytí kódu.

flags

number

Hodnota příznaků určuje úroveň podrobností pokrytí kódu, které se mají načíst. Příznaky jsou doplňkové. Očekávané hodnoty jsou 1 pro moduly, 2 pro functions, 4 pro BlockData.

Návraty

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Získání protokolů zpráv o testovacím spuštění

function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID spuštění, které chcete získat.

Návraty

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

Získejte seznam testovacích běhů.

function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>

Parametry

project

string

ID projektu nebo název projektu

buildUri

string

Identifikátor URI sestavení, které se použilo.

owner

string

ID základu týmu vlastníka spuštění.

tmiRunId

string

planId

number

ID testovacího plánu, na kterém jsou spuštění součástí.

includeRunDetails

boolean

Pokud je hodnota true, zahrňte všechny vlastnosti spuštění.

automated

boolean

Pokud je pravda, vrátí se pouze automatizovaná spuštění.

skip

number

Počet testovacích spuštění, která se mají přeskočit

top

number

Počet testovacích spuštění, která se mají vrátit.

Návraty

Promise<TestRun[]>

getTestRunStatistics(string, number)

Získejte statistiku testovacího běhu , která se používá, když chceme získat souhrn spuštění podle výsledku.

function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID spuštění, které chcete získat.

Návraty

Promise<TestRunStatistic>

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

Získání seznamu testovacích relací

function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>

Parametry

teamContext
TeamContext

Kontext týmu pro operaci

period

number

Období v dnech od této chvíle, pro které se načítají testovací relace.

allSessions

boolean

Pokud je false, vrátí testovací relace pro aktuálního uživatele. V opačném případě vrátí testovací relace pro všechny uživatele.

includeAllProperties

boolean

Pokud je hodnota true, vrátí všechny vlastnosti testovacích relací. V opačném případě vrátí hubenou verzi.

source
TestSessionSource

Zdroj testovací relace.

includeOnlyCompletedSessions

boolean

Pokud je pravda, vrátí testovací relace v dokončeném stavu. V opačném případě vrátí testovací relace pro všechny stavy.

Návraty

Promise<TestSession[]>

getTestSettingsById(string, number)

function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>

Parametry

project

string

ID projektu nebo název projektu

testSettingsId

number

Návraty

Promise<TestSettings>

getTestSubResultAttachmentContent(string, number, number, number, number)

Stažení přílohy výsledků testu

function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledků testu, které obsahují dílčí výsledek.

attachmentId

number

ID přílohy výsledků testu, která se má stáhnout

testSubResultId

number

ID testovacího dílčího výsledku, jehož příloha se musí stáhnout

Návraty

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Získání seznamu příloh dílčích výsledků testu

function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledků testu, které obsahují dílčí výsledek.

testSubResultId

number

ID testovacího dílčího výsledku, jehož příloha se musí stáhnout

Návraty

Promise<TestAttachment[]>

getTestSubResultAttachmentZip(string, number, number, number, number)

Stažení přílohy výsledků testu

function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Parametry

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, které obsahuje výsledek.

testCaseResultId

number

ID výsledků testu, které obsahují dílčí výsledek.

attachmentId

number

ID přílohy výsledků testu, která se má stáhnout

testSubResultId

number

ID testovacího dílčího výsledku, jehož příloha se musí stáhnout

Návraty

Promise<ArrayBuffer>

processSuitesForStaging(StagedSuitesRequestModel, string, number)

Zpracuje kolekci testovacích sad a vrátí model odpovědí obsahující podrobnosti o sadě a testovacím případu.

function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>

Parametry

request
StagedSuitesRequestModel

Model požadavku obsahující testovací sady, které mají být zpracovány. Nemůže být null.

project

string

ID projektu nebo název projektu

workItemId

number

Návraty

publishTestResultDocument(TestResultDocument, string, number)

function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>

Parametry

project

string

ID projektu nebo název projektu

runId

number

Návraty

queryCustomFields(string, CustomTestFieldScope)

function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>

Parametry

project

string

ID projektu nebo název projektu

scopeFilter
CustomTestFieldScope

Návraty

queryResultTrendForBuild(TestResultTrendFilter, string)

function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Parametry

project

string

ID projektu nebo název projektu

Návraty

queryResultTrendForRelease(TestResultTrendFilter, string)

function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Parametry

project

string

ID projektu nebo název projektu

Návraty

queryTestHistory(TestHistoryQuery, string)

Získání historie testovací metody pomocí TestHistoryQuery

function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>

Parametry

filter
TestHistoryQuery

TestHistoryQuery pro získání historie

project

string

ID projektu nebo název projektu

Návraty

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>

Parametry

project

string

ID projektu nebo název projektu

testName

string

Návraty

queryTestResultHistory(ResultsFilter, string)

function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>

Parametry

filter
ResultsFilter
project

string

ID projektu nebo název projektu

Návraty

queryTestResultsMetaData(string[], string)

Získání seznamu podrobností metadat výsledku testu pro odpovídající id testcasereferenceId

function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>

Parametry

testReferenceIds

string[]

ID testCaseReference výsledku testu, na které se má dotazovat, čárkami oddělený seznam platných ID (limit ne id 200).

project

string

ID projektu nebo název projektu

Návraty

Promise<TestResultMetaData[]>

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)

function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>

Parametry

project

string

ID projektu nebo název projektu

buildId

number

publishContext

string

includeFailureDetails

boolean

buildToCompare
BuildReference

Návraty

queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)

function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>

Parametry

project

string

ID projektu nebo název projektu

releaseId

number

releaseEnvId

number

publishContext

string

includeFailureDetails

boolean

releaseToCompare
ReleaseReference

Návraty

queryTestResultsSummaryForReleases(ReleaseReference[], string)

function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>

Parametry

releases

ReleaseReference[]

project

string

ID projektu nebo název projektu

Návraty

Promise<TestResultSummary[]>

queryTestResultWorkItems(string, string, string, number, Date, number, number)

function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>

Parametry

project

string

ID projektu nebo název projektu

workItemCategory

string

automatedTestName

string

testCaseId

number

maxCompleteDate

Date

days

number

workItemCount

number

Návraty

Promise<WorkItemReference[]>

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)

Dotazování testovacích běhů na základě filtrů Povinná pole jsou minLastUpdatedDate a maxLastUpdatedDate.

function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, continuationToken?: string): Promise<PagedList<TestRun>>

Parametry

project

string

ID projektu nebo název projektu

minLastUpdatedDate

Date

Minimální datum poslední změny spuštění, které se má dotazovat (povinné).

maxLastUpdatedDate

Date

Maximální datum poslední změny spuštění, které se má dotazovat (povinný argument, rozdíl mezi minimálním a maximálním datem může být maximálně 7 dnů).

state
TestRunState

Aktuální stav spuštění, která se mají dotazovat.

planIds

number[]

ID plánu spuštění, na která se má dotazovat, čárkami oddělený seznam platných ID (limit ne id 10).

isAutomated

boolean

Typ automatizace spuštění, která se mají dotazovat.

publishContext
TestRunPublishContext

PublishContext spuštění, která se mají dotazovat.

buildIds

number[]

ID sestavení spuštění, která se mají dotazovat, čárkami oddělený seznam platných ID (limit ne. id 10).

buildDefIds

number[]

ID definice sestavení spuštění, na která se má dotazovat, čárkami oddělený seznam platných ID (limit ne id 10).

branchName

string

Název zdrojové větve spuštění, která se mají dotazovat.

releaseIds

number[]

ID vydaných verzí spuštění, na která se mají dotazovat, čárkami oddělený seznam platných ID (limit ne id 10).

releaseDefIds

number[]

ID definic vydané verze spuštění, která se mají dotazovat, čárkami oddělený seznam platných ID (limit ne id 10).

releaseEnvIds

number[]

ID prostředí vydané verze spuštění, která se mají dotazovat, čárkami oddělený seznam platných ID (limit ne id 10).

releaseEnvDefIds

number[]

ID definic prostředí vydané verze spuštění, na která se má dotazovat, čárkami oddělený seznam platných ID (limit ne id 10).

runTitle

string

Spusťte název spuštění spuštění, která se mají dotazovat.

top

number

Počet spuštění, která se mají dotazovat. Limit je 100.

continuationToken

string

continuationToken přijatý z předchozí dávky nebo null pro první dávku. Nemělo by být vytvořeno (nebo změněno, pokud je přijato z poslední dávky) uživatelem.

Návraty

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>

Parametry

resultsContext
TestResultsContext
project

string

ID projektu nebo název projektu

workItemIds

number[]

Návraty

removeTestCasesFromSuiteUrl(string, number, number, string)

Testovací body přidružené k testovacím případům se z testovací sady odeberou. Pracovní položka testovacího případu se ze systému neodstraní. Pokud chcete trvale odstranit testovací případ, podívejte se na prostředek testovacích případů.

function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu, který obsahuje sadu.

suiteId

number

ID sady, která se má získat.

testCaseIds

string

ID testovacích případů, které se mají ze sady odebrat.

Návraty

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Požadavek: Souhrn pokrytí kódu ve formátu JSON

function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>

Parametry

coverageData
CodeCoverageData
project

string

ID projektu nebo název projektu

buildId

number

Návraty

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Aktualizace nastavení uchovávání výsledků testu

function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>

Parametry

retentionSettings
ResultRetentionSettings

Podrobnosti o nastavení uchovávání výsledků testu, které se mají aktualizovat

project

string

ID projektu nebo název projektu

Návraty

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

Aktualizuje vlastnosti přidružení testovacího případu v sadě.

function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

Parametry

suiteTestCaseUpdateModel
SuiteTestCaseUpdateModel

Model pro updaci vlastností přidružení sady testovacích případů

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu, který obsahuje sadu.

suiteId

number

ID sady testů, do které musí být přidány testovací případy.

testCaseIds

string

ID testovacích případů, které se mají přidat do sady ID jsou zadána ve formátu odděleném čárkami.

Návraty

Promise<SuiteTestCase[]>

updateTestPoints(PointUpdateModel, string, number, number, string)

Aktualizujte testovací body.

function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>

Parametry

pointUpdateModel
PointUpdateModel

Data, která se mají aktualizovat.

project

string

ID projektu nebo název projektu

planId

number

ID testovacího plánu.

suiteId

number

ID sady, která obsahuje body.

pointIds

string

ID testovacího bodu, který chcete získat. K aktualizaci více testovacích bodů použijte čárkami oddělený seznam ID.

Návraty

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Aktualizace výsledků testu při testovacím spuštění

function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametry

results

TestCaseResult[]

Seznam výsledků testů, které se mají aktualizovat

project

string

ID projektu nebo název projektu

runId

number

ID testovacího spuštění, jehož výsledky testů se mají aktualizovat.

Návraty

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Aktualizujte testovací běh podle ID.

function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>

Parametry

runUpdateModel
RunUpdateModel

Spuštění podrobností RunUpdateModel

project

string

ID projektu nebo název projektu

runId

number

ID spuštění, které se má aktualizovat.

Návraty

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Aktualizace testovací relace

function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

Parametry

testSession
TestSession

Podrobnosti o testovací relaci pro aktualizaci

teamContext
TeamContext

Kontext týmu pro operaci

Návraty

Promise<TestSession>