Lezen in het Engels

Share via


TestRestClient class

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

Constructors

Eigenschappen

Methoden

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

Voeg testcases toe aan het pakket.

addTestResultsToTestRun(TestCaseResult[], string, number)

Testresultaten toevoegen aan een testuitvoering.

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

Voeg een bestand toe aan het resultaat van de teststap

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Voeg een bestand toe aan een testresultaat.

createTestRun(RunCreateModel, string)

Nieuwe testuitvoering maken.

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Voeg een bestand toe aan een testuitvoering.

createTestSession(TestSession, TeamContext)

Een testsessie maken

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

Een bestand toevoegen aan een testresultaat

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

Een testcase verwijderen.

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

Verwijder een testuitvoering op basis van de bijbehorende id.

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

Codedekkingsgegevens voor een build ophalen.

getCodeCoverageSummary(string, number, number)

Samenvatting van codedekking voor build ophalen.

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

Een testpunt ophalen.

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

Een lijst met testpunten ophalen.

getPointsByQuery(TestPointsQuery, string, number, number)

Testpunten ophalen met behulp van query.

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

Bewaarinstellingen voor testresultaten ophalen

getTestCaseById(string, number, number, number)

Haal een specifieke testcase op in een testsuite met testcase-id.

getTestCases(string, number, number)

Alle testcases in een suite ophalen.

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

Iteratie ophalen voor een resultaat

getTestIterations(string, number, number, boolean)

Iteraties voor een resultaat ophalen

getTestResultAttachmentContent(string, number, number, number)

Download een bijlage met testresultaten op basis van de bijbehorende id.

getTestResultAttachments(string, number, number)

Haal een lijst op met naslaginformatie over bijlagen met testresultaten.

getTestResultAttachmentZip(string, number, number, number)

Download een bijlage met testresultaten op basis van de bijbehorende id.

getTestResultById(string, number, number, ResultDetails)

Haal een testresultaat op voor een testuitvoering.

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[])

Testresultaten ophalen voor een testuitvoering.

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

Deze API retourneert resultaten per id met velden die zijn opgegeven/trend voor een bepaalde geautomatiseerde testmethode. Deze API wordt nog steeds verbeterd en de juiste handtekening en het juiste contract zijn nog niet voltooid.

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

Download een testuitvoeringsbijlage op basis van de bijbehorende id.

getTestRunAttachments(string, number)

Haal een lijst met naslaginformatie over testuitvoeringsbijlagen op.

getTestRunAttachmentZip(string, number, number)

Download een testuitvoeringsbijlage op basis van de bijbehorende id.

getTestRunById(string, number, boolean)

Een test uitvoeren op basis van de id.

getTestRunCodeCoverage(string, number, number)

Codedekkingsgegevens ophalen voor een testuitvoering

getTestRunLogs(string, number)

Berichtenlogboeken voor testuitvoeringen ophalen

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

Een lijst met testuitvoeringen ophalen.

getTestRunStatistics(string, number)

Statistieken van testuitvoeringen ophalen , die worden gebruikt wanneer we een samenvatting van een uitvoering per resultaat willen ophalen.

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

Een lijst met testsessies ophalen

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

Een bijlage met testresultaten downloaden

getTestSubResultAttachments(string, number, number, number)

Lijst met bijlagen met testsubresultaten ophalen

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

Een bijlage met testresultaten downloaden

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

De geschiedenis van een testmethode ophalen met Behulp van TestHistoryQuery

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

Lijst met metagegevens van testresultaten ophalen voor de bijbehorende 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)

Query's uitvoeren op testuitvoeringen op basis van filters. Verplichte velden zijn minLastUpdatedDate en maxLastUpdatedDate.

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

De testpunten die aan de testcases zijn gekoppeld, worden verwijderd uit de testsuite. Het werkitem van de testcase wordt niet verwijderd uit het systeem. Zie de testcaseresource om een testcase definitief te verwijderen.

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary

updateResultRetentionSettings(ResultRetentionSettings, string)

Bewaarinstellingen voor testresultaten bijwerken

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

Updates de eigenschappen van de testcasekoppeling in een suite.

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

Testpunten bijwerken.

updateTestResults(TestCaseResult[], string, number)

Testresultaten bijwerken in een testuitvoering.

updateTestRun(RunUpdateModel, string, number)

Werk de test bij die wordt uitgevoerd op basis van de id.

updateTestSession(TestSession, TeamContext)

Een testsessie bijwerken

Constructordetails

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addCustomFields(CustomTestFieldDefinition[], string)

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

Parameters

project

string

Project-id of projectnaam

Retouren

addTestCasesToSuite(string, number, number, string)

Voeg testcases toe aan het pakket.

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

Parameters

project

string

Project-id of projectnaam

planId

number

Id van het testplan dat de suite bevat.

suiteId

number

Id van de testsuite waaraan de testcases moeten worden toegevoegd.

testCaseIds

string

Id's van de testcases die u aan de suite wilt toevoegen. Id's worden opgegeven in door komma's gescheiden indeling.

Retouren

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

Testresultaten toevoegen aan een testuitvoering.

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

Parameters

results

TestCaseResult[]

Lijst met testresultaten om toe te voegen.

project

string

Project-id of projectnaam

runId

number

Test run ID in welke testresultaten moeten worden toegevoegd.

Retouren

Promise<TestCaseResult[]>

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

Parameters

workItemToTestLinks
WorkItemToTestLinks
project

string

Project-id of projectnaam

Retouren

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

Voeg een bestand toe aan het resultaat van de teststap

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

Parameters

attachmentRequestModel
TestAttachmentRequestModel

Bijlagedetails TestAttachmentRequestModel

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van het testresultaat dat de iteratie bevat

iterationId

number

Id van de iteratie van het testresultaat.

actionPath

string

Hexwaarde van actiepad voor testresultaat.

Retouren

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Voeg een bestand toe aan een testresultaat.

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

Parameters

attachmentRequestModel
TestAttachmentRequestModel

Bijlagedetails TestAttachmentRequestModel

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van het testresultaat waarvan de bijlage moet worden geüpload.

Retouren

createTestRun(RunCreateModel, string)

Nieuwe testuitvoering maken.

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

Parameters

testRun
RunCreateModel

Uitvoeringsdetails RunCreateModel

project

string

Project-id of projectnaam

Retouren

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Voeg een bestand toe aan een testuitvoering.

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

Parameters

attachmentRequestModel
TestAttachmentRequestModel

Bijlagedetails TestAttachmentRequestModel

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering waarvoor de bijlage moet worden geüpload.

Retouren

createTestSession(TestSession, TeamContext)

Een testsessie maken

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

Parameters

testSession
TestSession

Details van testsessie voor het maken

teamContext
TeamContext

De teamcontext voor de bewerking

Retouren

Promise<TestSession>

createTestSettings(TestSettings, string)

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

Parameters

testSettings
TestSettings
project

string

Project-id of projectnaam

Retouren

Promise<number>

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

Een bestand toevoegen aan een testresultaat

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

Parameters

attachmentRequestModel
TestAttachmentRequestModel

Model van bijlageaanvraag.

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van de testresultaten die subresultaat bevatten.

testSubResultId

number

Id van de testsubresultaten op basis waarvan de bijlage moet worden geüpload.

Retouren

deleteSharedParameter(string, number)

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

Parameters

project

string

Project-id of projectnaam

sharedParameterId

number

Retouren

Promise<void>

deleteSharedStep(string, number)

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

Parameters

project

string

Project-id of projectnaam

sharedStepId

number

Retouren

Promise<void>

deleteTestCase(string, number)

Een testcase verwijderen.

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

Parameters

project

string

Project-id of projectnaam

testCaseId

number

Id van testcase die moet worden verwijderd.

Retouren

Promise<void>

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

Parameters

project

string

Project-id of projectnaam

testName

string

workItemId

number

Retouren

Promise<boolean>

deleteTestRun(string, number)

Verwijder een testuitvoering op basis van de bijbehorende id.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de uitvoering die moet worden verwijderd.

Retouren

Promise<void>

deleteTestSettings(string, number)

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

Parameters

project

string

Project-id of projectnaam

testSettingsId

number

Retouren

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

Parameters

project

string

Project-id of projectnaam

runId

number

testCaseResultId

number

Retouren

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

Codedekkingsgegevens voor een build ophalen.

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

Parameters

project

string

Project-id of projectnaam

buildId

number

Id van de build waarvoor codedekkingsgegevens moeten worden opgehaald.

flags

number

De waarde van vlaggen bepaalt het niveau van de codedekkingsdetails die moeten worden opgehaald. Vlaggen zijn additief. Verwachte waarden zijn 1 voor Modules, 2 voor Functions, 4 voor BlockData.

Retouren

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

Samenvatting van codedekking voor build ophalen.

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

Parameters

project

string

Project-id of projectnaam

buildId

number

Id van de build waarvoor codedekkingsgegevens moeten worden opgehaald.

deltaBuildId

number

Delta Build-id (optioneel)

Retouren

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

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

Parameters

workItemQuery
LinkedWorkItemsQuery
project

string

Project-id of projectnaam

Retouren

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

Een testpunt ophalen.

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

Parameters

project

string

Project-id of projectnaam

planId

number

Id van het testplan.

suiteId

number

Id van de suite die het punt bevat.

pointIds

number

Id van het testpunt dat moet worden opgehaald.

witFields

string

Door komma's gescheiden lijst met veldnamen voor werkitems.

Retouren

Promise<TestPoint>

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

Een lijst met testpunten ophalen.

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

Parameters

project

string

Project-id of projectnaam

planId

number

Id van het testplan.

suiteId

number

Id van de suite die de punten bevat.

witFields

string

Door komma's gescheiden lijst met veldnamen voor werkitems.

configurationId

string

Testpunten ophalen voor specifieke configuratie.

testCaseId

string

Testpunten ophalen voor een specifieke testcase, geldig wanneer configurationId niet is ingesteld.

testPointIds

string

Testpunten ophalen voor door komma's gescheiden lijst met testpunt-id's, die alleen geldig zijn als configurationId en testCaseId niet zijn ingesteld.

includePointDetails

boolean

Neem alle eigenschappen voor het testpunt op.

skip

number

Aantal testpunten dat u wilt overslaan.

top

number

Aantal testpunten dat moet worden geretourneerd.

Retouren

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

Testpunten ophalen met behulp van query.

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

Parameters

query
TestPointsQuery

TestPointsQuery om testpunten te verkrijgen.

project

string

Project-id of projectnaam

skip

number

Aantal testpunten dat u wilt overslaan.

top

number

Aantal testpunten dat moet worden geretourneerd.

Retouren

Promise<TestPointsQuery>

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

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

Parameters

project

string

Project-id of projectnaam

buildId

number

publishContext

string

fields

string[]

continuationToken

string

Retouren

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

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

Parameters

project

string

Project-id of projectnaam

releaseId

number

publishContext

string

releaseEnvId

number

fields

string[]

continuationToken

string

Retouren

getResultRetentionSettings(string)

Bewaarinstellingen voor testresultaten ophalen

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

Parameters

project

string

Project-id of projectnaam

Retouren

getTestCaseById(string, number, number, number)

Haal een specifieke testcase op in een testsuite met testcase-id.

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

Parameters

project

string

Project-id of projectnaam

planId

number

Id van het testplan dat de suites bevat.

suiteId

number

Id van de suite die de testcase bevat.

testCaseIds

number

Id van de testcase die moet worden opgehaald.

Retouren

Promise<SuiteTestCase>

getTestCases(string, number, number)

Alle testcases in een suite ophalen.

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

Parameters

project

string

Project-id of projectnaam

planId

number

Id van het testplan dat de suites bevat.

suiteId

number

Id van de suite die u wilt ophalen.

Retouren

Promise<SuiteTestCase[]>

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

Iteratie ophalen voor een resultaat

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van het testresultaat dat de iteraties bevat.

iterationId

number

Id van de testresultaten Iteratie.

includeActionResults

boolean

Voeg resultaatdetails toe voor elke actie die in de test-iteratie wordt uitgevoerd. ActionResults verwijst naar het resultaat (slagen/mislukken) van teststappen die worden uitgevoerd als onderdeel van een handmatige test. Als u de vlag ActionResults opgeeft, wordt het resultaat van de teststappen in de sectie actionResults en de testparameters in de sectie parameters voor elke testiteratie weergegeven.

Retouren

getTestIterations(string, number, number, boolean)

Iteraties voor een resultaat ophalen

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van het testresultaat dat de iteraties bevat.

includeActionResults

boolean

Voeg resultaatdetails toe voor elke actie die in de test-iteratie wordt uitgevoerd. ActionResults verwijst naar het resultaat (slagen/mislukken) van teststappen die worden uitgevoerd als onderdeel van een handmatige test. Als u de vlag ActionResults opgeeft, wordt het resultaat van de teststappen in de sectie actionResults en de testparameters in de sectie parameters voor elke testiteratie weergegeven.

Retouren

getTestResultAttachmentContent(string, number, number, number)

Download een bijlage met testresultaten op basis van de bijbehorende id.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die de testCaseResultId bevat.

testCaseResultId

number

Id van het testresultaat waarvan de bijlage moet worden gedownload.

attachmentId

number

Id van de bijlage met het testresultaat die moet worden gedownload.

Retouren

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

Haal een lijst op met naslaginformatie over bijlagen met testresultaten.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van het testresultaat.

Retouren

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Download een bijlage met testresultaten op basis van de bijbehorende id.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die de testCaseResultId bevat.

testCaseResultId

number

Id van het testresultaat waarvan de bijlage moet worden gedownload.

attachmentId

number

Id van de bijlage met het testresultaat die moet worden gedownload.

Retouren

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

Haal een testresultaat op voor een testuitvoering.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Testuitvoerings-id van een testresultaat dat moet worden opgehaald.

testCaseResultId

number

Testresultaat-id.

detailsToInclude
ResultDetails

Details die moeten worden opgenomen in de testresultaten. De standaardwaarde is Geen. Andere waarden zijn Iteraties, WorkItems en SubResults.

Retouren

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>

Parameters

project

string

Project-id of projectnaam

buildId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

Retouren

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>

Parameters

project

string

Project-id of projectnaam

releaseId

number

releaseEnvId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

Retouren

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

Testresultaten ophalen voor een testuitvoering.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Testuitvoerings-id van testresultaten die moeten worden opgehaald.

detailsToInclude
ResultDetails

Details die moeten worden opgenomen in de testresultaten. De standaardwaarde is Geen. Andere waarden zijn Iteraties en WorkItems.

skip

number

Het aantal testresultaten dat vanaf het begin moet worden overgeslagen.

top

number

Aantal testresultaten dat moet worden geretourneerd. Maximum is 1000 wanneer detailsToInclude Geen is en 200 anders.

outcomes

TestOutcome[]

Door komma's gescheiden lijst met testresultaten om testresultaten te filteren.

Retouren

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>>

Parameters

project

string

Project-id of projectnaam

buildId

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

Retouren

getTestResultsByQuery(TestResultsQuery, string)

Deze API retourneert resultaten per id met velden die zijn opgegeven/trend voor een bepaalde geautomatiseerde testmethode. Deze API wordt nog steeds verbeterd en de juiste handtekening en het juiste contract zijn nog niet voltooid.

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

Parameters

project

string

Project-id of projectnaam

Retouren

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>>

Parameters

project

string

Project-id of projectnaam

releaseId

number

releaseEnvid

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

Retouren

getTestRunAttachmentContent(string, number, number)

Download een testuitvoeringsbijlage op basis van de bijbehorende id.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering waarvan de bijlage moet worden gedownload.

attachmentId

number

Id van de bijlage voor de testuitvoering die moet worden gedownload.

Retouren

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

Haal een lijst met naslaginformatie over testuitvoeringsbijlagen op.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering.

Retouren

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

Download een testuitvoeringsbijlage op basis van de bijbehorende id.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering waarvan de bijlage moet worden gedownload.

attachmentId

number

Id van de bijlage voor de testuitvoering die moet worden gedownload.

Retouren

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

Een test uitvoeren op basis van de id.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de uitvoering die moet worden opgehaald.

includeDetails

boolean

De standaardwaarde is Waar. Het bevat details zoals uitvoeringsstatistieken, release, build, testomgeving, postprocesstatus en meer.

Retouren

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

Codedekkingsgegevens ophalen voor een testuitvoering

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering waarvoor codedekkingsgegevens moeten worden opgehaald.

flags

number

De waarde van vlaggen bepaalt het niveau van de codedekkingsdetails die moeten worden opgehaald. Vlaggen zijn additief. Verwachte waarden zijn 1 voor Modules, 2 voor Functies en 4 voor BlockData.

Retouren

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

Berichtenlogboeken voor testuitvoeringen ophalen

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de uitvoering die moet worden opgehaald.

Retouren

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

Een lijst met testuitvoeringen ophalen.

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

Parameters

project

string

Project-id of projectnaam

buildUri

string

URI van de build die wordt uitgevoerd.

owner

string

Teambasis-id van de eigenaar van de uitvoeringen.

tmiRunId

string

planId

number

Id van het testplan waarvan de uitvoeringen deel uitmaken.

includeRunDetails

boolean

Als dit waar is, neemt u alle eigenschappen van de uitvoeringen op.

automated

boolean

Als dit waar is, retourneert alleen geautomatiseerde uitvoeringen.

skip

number

Aantal testuitvoeringen dat moet worden overgeslagen.

top

number

Aantal testuitvoeringen dat moet worden geretourneerd.

Retouren

Promise<TestRun[]>

getTestRunStatistics(string, number)

Statistieken van testuitvoeringen ophalen , die worden gebruikt wanneer we een samenvatting van een uitvoering per resultaat willen ophalen.

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de uitvoering die moet worden opgehaald.

Retouren

Promise<TestRunStatistic>

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

Een lijst met testsessies ophalen

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

Parameters

teamContext
TeamContext

De teamcontext voor de bewerking

period

number

Periode in dagen vanaf nu, waarvoor testsessies worden opgehaald.

allSessions

boolean

Indien onwaar, retourneert testsessies voor de huidige gebruiker. Anders retourneert het testsessies voor alle gebruikers

includeAllProperties

boolean

Als dit waar is, worden alle eigenschappen van de testsessies geretourneerd. Anders wordt de magere versie geretourneerd.

source
TestSessionSource

Bron van de testsessie.

includeOnlyCompletedSessions

boolean

Als dit waar is, worden testsessies met de status Voltooid geretourneerd. Anders retourneert het testsessies voor alle statussen

Retouren

Promise<TestSession[]>

getTestSettingsById(string, number)

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

Parameters

project

string

Project-id of projectnaam

testSettingsId

number

Retouren

Promise<TestSettings>

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

Een bijlage met testresultaten downloaden

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van de testresultaten die subresultaat bevatten.

attachmentId

number

Id van de bijlage met het testresultaat die moet worden gedownload

testSubResultId

number

Id van het testsubresultaat waarvan de bijlage moet worden gedownload

Retouren

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Lijst met bijlagen met testsubresultaten ophalen

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van de testresultaten die subresultaat bevatten.

testSubResultId

number

Id van het testsubresultaat waarvan de bijlage moet worden gedownload

Retouren

Promise<TestAttachment[]>

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

Een bijlage met testresultaten downloaden

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

Parameters

project

string

Project-id of projectnaam

runId

number

Id van de testuitvoering die het resultaat bevat.

testCaseResultId

number

Id van de testresultaten die subresultaat bevatten.

attachmentId

number

Id van de bijlage met het testresultaat die moet worden gedownload

testSubResultId

number

Id van het testsubresultaat waarvan de bijlage moet worden gedownload

Retouren

Promise<ArrayBuffer>

publishTestResultDocument(TestResultDocument, string, number)

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

Parameters

project

string

Project-id of projectnaam

runId

number

Retouren

queryCustomFields(string, CustomTestFieldScope)

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

Parameters

project

string

Project-id of projectnaam

scopeFilter
CustomTestFieldScope

Retouren

queryResultTrendForBuild(TestResultTrendFilter, string)

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

Parameters

project

string

Project-id of projectnaam

Retouren

queryResultTrendForRelease(TestResultTrendFilter, string)

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

Parameters

project

string

Project-id of projectnaam

Retouren

queryTestHistory(TestHistoryQuery, string)

De geschiedenis van een testmethode ophalen met Behulp van TestHistoryQuery

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

Parameters

filter
TestHistoryQuery

TestHistoryQuery om geschiedenis op te halen

project

string

Project-id of projectnaam

Retouren

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

Parameters

project

string

Project-id of projectnaam

testName

string

Retouren

queryTestResultHistory(ResultsFilter, string)

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

Parameters

filter
ResultsFilter
project

string

Project-id of projectnaam

Retouren

queryTestResultsMetaData(string[], string)

Lijst met metagegevens van testresultaten ophalen voor de bijbehorende testcasereferenceId

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

Parameters

testReferenceIds

string[]

TestCaseReference-id's van het testresultaat dat moet worden opgevraagd, door komma's gescheiden lijst met geldige id's (limiet aantal id's 200).

project

string

Project-id of projectnaam

Retouren

Promise<TestResultMetaData[]>

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

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

Parameters

project

string

Project-id of projectnaam

buildId

number

publishContext

string

includeFailureDetails

boolean

buildToCompare
BuildReference

Retouren

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

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

Parameters

project

string

Project-id of projectnaam

releaseId

number

releaseEnvId

number

publishContext

string

includeFailureDetails

boolean

releaseToCompare
ReleaseReference

Retouren

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

Parameters

releases

ReleaseReference[]

project

string

Project-id of projectnaam

Retouren

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[]>

Parameters

project

string

Project-id of projectnaam

workItemCategory

string

automatedTestName

string

testCaseId

number

maxCompleteDate

Date

days

number

workItemCount

number

Retouren

Promise<WorkItemReference[]>

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

Query's uitvoeren op testuitvoeringen op basis van filters. Verplichte velden zijn minLastUpdatedDate en 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>>

Parameters

project

string

Project-id of projectnaam

minLastUpdatedDate

Date

Minimale datum van laatste wijziging van de uitvoering die moet worden opgevraagd (verplicht).

maxLastUpdatedDate

Date

Maximumdatum laatst gewijzigd waarop een query moet worden uitgevoerd (verplicht, het verschil tussen de minimale en de maximale datum kan maximaal 7 dagen zijn).

state
TestRunState

Huidige status van de uitvoeringen die moeten worden opgevraagd.

planIds

number[]

Plan id's van de uitvoeringen die moeten worden opgevraagd, door komma's gescheiden lijst met geldige id's (limietnummer van id's 10).

isAutomated

boolean

Automatiseringstype van de uitvoeringen die moeten worden opgevraagd.

publishContext
TestRunPublishContext

PublishContext van de uitvoeringen die moeten worden opgevraagd.

buildIds

number[]

Build-id's van de uitvoeringen die moeten worden opgevraagd, door komma's gescheiden lijst met geldige id's (limietnummer van id's 10).

buildDefIds

number[]

Bouw definitie-id's van de uitvoeringen die moeten worden opgevraagd, door komma's gescheiden lijst met geldige id's (limiet aantal id's 10).

branchName

string

De naam van de bronbranch van de uitvoeringen die moeten worden opgevraagd.

releaseIds

number[]

Release-id's van de uitvoeringen die moeten worden opgevraagd, door komma's gescheiden lijst met geldige id's (limietnummer van id's 10).

releaseDefIds

number[]

ReleaseDefinitie-id's van de uitvoeringen die moeten worden opgevraagd, door komma's gescheiden lijst met geldige id's (limiet aantal id's 10).

releaseEnvIds

number[]

Release-omgevings-id's van de uitvoeringen die moeten worden opgevraagd, door komma's gescheiden lijst met geldige id's (limiet nr. van id's 10).

releaseEnvDefIds

number[]

Release Environment Definition Ids of the Runs to be queryd, door komma's gescheiden lijst met geldige id's (limit no. of ids 10).

runTitle

string

Run Title van de uitvoeringen die moeten worden opgevraagd.

top

number

Aantal uitvoeringen waarop een query moet worden uitgevoerd. Limiet is 100

continuationToken

string

continuationToken ontvangen van de vorige batch of null voor de eerste batch. Het is niet de bedoeling dat deze door de gebruiker wordt gemaakt (of gewijzigd, indien ontvangen van de laatste batch).

Retouren

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

Parameters

resultsContext
TestResultsContext
project

string

Project-id of projectnaam

workItemIds

number[]

Retouren

removeTestCasesFromSuiteUrl(string, number, number, string)

De testpunten die aan de testcases zijn gekoppeld, worden verwijderd uit de testsuite. Het werkitem van de testcase wordt niet verwijderd uit het systeem. Zie de testcaseresource om een testcase definitief te verwijderen.

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

Parameters

project

string

Project-id of projectnaam

planId

number

Id van het testplan dat de suite bevat.

suiteId

number

Id van de suite die moet worden opgehaald.

testCaseIds

string

Id's van de testcases die uit de suite moeten worden verwijderd.

Retouren

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary

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

Parameters

coverageData
CodeCoverageData
project

string

Project-id of projectnaam

buildId

number

Retouren

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

Bewaarinstellingen voor testresultaten bijwerken

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

Parameters

retentionSettings
ResultRetentionSettings

Details van bewaarinstellingen voor testresultaten die moeten worden bijgewerkt

project

string

Project-id of projectnaam

Retouren

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

Updates de eigenschappen van de testcasekoppeling in een suite.

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

Parameters

suiteTestCaseUpdateModel
SuiteTestCaseUpdateModel

Model voor updatie van de eigenschappen van de koppeling van testcasesuites.

project

string

Project-id of projectnaam

planId

number

Id van het testplan dat de suite bevat.

suiteId

number

Id van de testsuite waaraan de testcases moeten worden toegevoegd.

testCaseIds

string

Id's van de testcases die u aan de suite wilt toevoegen. Id's worden opgegeven in door komma's gescheiden indeling.

Retouren

Promise<SuiteTestCase[]>

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

Testpunten bijwerken.

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

Parameters

pointUpdateModel
PointUpdateModel

Bij te werken gegevens.

project

string

Project-id of projectnaam

planId

number

Id van het testplan.

suiteId

number

Id van de suite die de punten bevat.

pointIds

string

Id van het testpunt dat moet worden opgehaald. Gebruik een door komma's gescheiden lijst met id's om meerdere testpunten bij te werken.

Retouren

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

Testresultaten bijwerken in een testuitvoering.

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

Parameters

results

TestCaseResult[]

Lijst met testresultaten die moeten worden bijgewerkt.

project

string

Project-id of projectnaam

runId

number

Testuitvoerings-id waarvan de testresultaten moeten worden bijgewerkt.

Retouren

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

Werk de test bij die wordt uitgevoerd op basis van de id.

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

Parameters

runUpdateModel
RunUpdateModel

Uitvoeringsdetails RunUpdateModel

project

string

Project-id of projectnaam

runId

number

Id van de uitvoering die moet worden bijgewerkt.

Retouren

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

Een testsessie bijwerken

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

Parameters

testSession
TestSession

Details van testsessie voor update

teamContext
TeamContext

De teamcontext voor de bewerking

Retouren

Promise<TestSession>