TestHttpClient2_2

Important

Disclaimer: This API is in private preview and subject to change. This API is in private preview and subject to change.

Note

Looking for Azure DevOps REST APIs? See the latest Azure DevOps REST API reference.

For information about .NET client libraries, see .NET client libraries for Azure DevOps.

Module path: TFS/TestManagement/RestClient

Initialization sample

  import RestClient = require("TFS/TestManagement/RestClient");

  // Get an instance of the client
  var client = RestClient.getClient();
    
  // Call a method on the client
  // e.g. client.getResource(...).then(...);

Methods

• addCustomFields()
• addTestCasesToSuite()
• addTestResultsToTestRun()
• bulkUpdateTestResults()
• cloneTestPlan()
• cloneTestSuite()
• createResultRetentionSettings()
• createTestConfiguration()
• createTestPlan()
• createTestResultAttachment()
• createTestRun()
• createTestRunAttachment()
• createTestSettings()
• createTestSuite()
• createTestSession()
• createTestVariable()
• deleteResultRetentionSettings()
• deleteTestConfiguration()
• deleteTestRun()
• deleteTestSettings()
• deleteTestSuite()
• deleteTestVariable()
• getActionResults()
• getBugsLinkedToTestResult()
• getBuildCodeCoverage()
• getCodeCoverageSummary()
• getPlanById()
• getPlanCloneInformation()
• getPlans()
• getPoint()
• getPoints()
• getResultParameters()
• getResultRetentionSettings()
• getSuiteCloneInformation()
• getSuiteEntries()
• getSuitesByTestCaseId()
• getTestCaseById()
• getTestCaseResultById()
• getTestCaseResults()
• getTestCases()
• getTestConfigurationById()
• getTestConfigurations()
• getTestIteration()
• getTestIterations()
• getTestResultAttachmentContent()
• getTestResultAttachmentZip()
• getTestResultById()
• getTestResultDetailsForBuild()
• getTestResults()
• getTestResultsByIds()
• getTestResultsByQuery()
• getTestRunAttachmentContent()
• getTestRunAttachmentZip()
• getTestRunById()
• getTestRunCodeCoverage()
• getTestRunLogs()
• getTestRuns()
• getTestRunsByQuery()
• getTestRunStatistics()
• getTestSettingsById()
• getTestSuiteById()
• getTestSuitesForPlan()
• getTestVariable()
• getTestSessions()
• getTestVariables()
• queryCustomFields()
• queryFailureDetailsForBuild()
• queryFailureDetailsForTestRun()
• queryReportForBuild()
• queryResultTrendForBuild()
• queryTestResultRecentBugs()
• queryTestResultTrendReport()
• removeTestCasesFromSuiteUrl()
• reorderSuiteEntries()
• updateCodeCoverageSummary()
• updateResultRetentionSettings()
• updateTestConfiguration()
• updateTestPlan()
• updateTestPoints()
• updateTestResults()
• updateTestRun()
• updateTestSuite()
• updateTestSession()
• updateTestVariable()

addCustomFields()

Syntax

 IPromise<Contracts.CustomTestFieldDefinition[]> addCustomFields(newFields, project)

Parameters

• newFields: Contracts.CustomTestFieldDefinition[].
• project: string.

Returns

• IPromise<Contracts.CustomTestFieldDefinition[]>

addTestCasesToSuite()

Syntax

 IPromise<Contracts.SuiteTestCase[]> addTestCasesToSuite(project, planId, suiteId, testCaseIds)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.
• testCaseIds: string.

Returns

• IPromise<Contracts.SuiteTestCase[]>

addTestResultsToTestRun()

Syntax

 IPromise<Contracts.TestCaseResult[]> addTestResultsToTestRun(resultCreateModels, project, runId)

Parameters

• resultCreateModels: Contracts.TestResultCreateModel[].
• project: string.
• runId: number.

Returns

• IPromise<Contracts.TestCaseResult[]>

bulkUpdateTestResults()

Syntax

 IPromise<Contracts.TestCaseResult[]> bulkUpdateTestResults(resultUpdateModel, project, runId, resultIds)

Parameters

• resultUpdateModel: Contracts.TestCaseResultUpdateModel.
• project: string.
• runId: number.
• resultIds: number[].

Returns

• IPromise<Contracts.TestCaseResult[]>

cloneTestPlan()

Syntax

 IPromise<Contracts.CloneOperationInformation> cloneTestPlan(cloneRequestBody, project, sourcePlanId)

Parameters

• cloneRequestBody: Contracts.TestPlanCloneRequest.
• project: string.
• sourcePlanId: number.

Returns

• IPromise<Contracts.CloneOperationInformation>

cloneTestSuite()

Syntax

 IPromise<Contracts.CloneOperationInformation> cloneTestSuite(cloneRequestBody, project, sourceSuiteId, planId)

Parameters

• cloneRequestBody: Contracts.TestSuiteCloneRequest.
• project: string.
• sourceSuiteId: number.
• planId: number.

Returns

• IPromise<Contracts.CloneOperationInformation>

createResultRetentionSettings()

Syntax

 IPromise<Contracts.ResultRetentionSettings> createResultRetentionSettings(retentionSettings, project)

Parameters

• retentionSettings: Contracts.ResultRetentionSettings.
• project: string.

Returns

• IPromise<Contracts.ResultRetentionSettings>

createTestConfiguration()

Syntax

 IPromise<Contracts.TestConfiguration> createTestConfiguration(testConfiguration, project)

Parameters

• testConfiguration: Contracts.TestConfiguration.
• project: string.

Returns

• IPromise<Contracts.TestConfiguration>

createTestPlan()

Syntax

 IPromise<Contracts.TestPlan> createTestPlan(testPlan, project)

Parameters

• testPlan: Contracts.PlanUpdateModel.
• project: string.

Returns

• IPromise<Contracts.TestPlan>

createTestResultAttachment()

Syntax

 IPromise<Contracts.TestAttachmentReference> createTestResultAttachment(attachmentRequestModel, project, runId, testCaseResultId)

Parameters

• attachmentRequestModel: Contracts.TestAttachmentRequestModel.
• project: string.
• runId: number.
• testCaseResultId: number.

Returns

• IPromise<Contracts.TestAttachmentReference>

createTestRun()

Syntax

 IPromise<Contracts.TestRun> createTestRun(testRun, project)

Parameters

• testRun: Contracts.RunCreateModel.
• project: string.

Returns

• IPromise<Contracts.TestRun>

createTestRunAttachment()

Syntax

 IPromise<Contracts.TestAttachmentReference> createTestRunAttachment(attachmentRequestModel, project, runId)

Parameters

• attachmentRequestModel: Contracts.TestAttachmentRequestModel.
• project: string.
• runId: number.

Returns

• IPromise<Contracts.TestAttachmentReference>

createTestSettings()

Syntax

 IPromise<number> createTestSettings(testSettings, project)

Parameters

• testSettings: Contracts.TestSettings.
• project: string.

Returns

• IPromise<number>

createTestSuite()

Syntax

 IPromise<Contracts.TestSuite[]> createTestSuite(testSuite, project, planId, suiteId)

Parameters

• testSuite: Contracts.SuiteCreateModel.
• project: string.
• planId: number.
• suiteId: number.

Returns

• IPromise<Contracts.TestSuite[]>

createTestSession()

Syntax

 IPromise<Contracts.TestSession> createTestSession(testSession, teamContext)

Parameters

• testSession: Contracts.TestSession.
• teamContext: Contracts.TeamContext.

Returns

• IPromise<Contracts.TestSession>

createTestVariable()

Syntax

 IPromise<Contracts.TestVariable> createTestVariable(testVariable, project)

Parameters

• testVariable: Contracts.TestVariable.
• project: string.

Returns

• IPromise<Contracts.TestVariable>

deleteResultRetentionSettings()

Syntax

 IPromise<void> deleteResultRetentionSettings(project)

Parameters

• project: string. Project ID or project name

Returns

• IPromise<void>

deleteTestConfiguration()

Syntax

 IPromise<void> deleteTestConfiguration(project, testConfigurationId)

Parameters

• project: string. Project ID or project name
• testConfigurationId: number.

Returns

• IPromise<void>

deleteTestRun()

Syntax

 IPromise<void> deleteTestRun(project, runId)

Parameters

• project: string. Project ID or project name
• runId: number.

Returns

• IPromise<void>

deleteTestSettings()

Syntax

 IPromise<void> deleteTestSettings(project, testSettingsId)

Parameters

• project: string. Project ID or project name
• testSettingsId: number.

Returns

• IPromise<void>

deleteTestSuite()

Syntax

 IPromise<void> deleteTestSuite(project, planId, suiteId)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.

Returns

• IPromise<void>

deleteTestVariable()

Syntax

 IPromise<void> deleteTestVariable(project, testVariableId)

Parameters

• project: string. Project ID or project name
• testVariableId: number.

Returns

• IPromise<void>

getActionResults()

Syntax

 IPromise<Contracts.TestActionResultModel[]> getActionResults(project, runId, testCaseResultId, iterationId, actionPath)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• iterationId: number.
• actionPath: string. Optional.

Returns

• IPromise<Contracts.TestActionResultModel[]>

getBugsLinkedToTestResult()

Syntax

 IPromise<Contracts.WorkItemReference[]> getBugsLinkedToTestResult(project, runId, testCaseResultId)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.

Returns

• IPromise<Contracts.WorkItemReference[]>

getBuildCodeCoverage()

Syntax

 IPromise<Contracts.BuildCoverage[]> getBuildCodeCoverage(project, buildId, flags)

Parameters

• project: string. Project ID or project name
• buildId: number.
• flags: number.

Returns

• IPromise<Contracts.BuildCoverage[]>

getCodeCoverageSummary()

Syntax

 IPromise<Contracts.CodeCoverageSummary> getCodeCoverageSummary(project, buildId, deltaBuildId)

Parameters

• project: string. Project ID or project name
• buildId: number.
• deltaBuildId: number. Optional.

Returns

• IPromise<Contracts.CodeCoverageSummary>

getPlanById()

Syntax

 IPromise<Contracts.TestPlan> getPlanById(project, planId)

Parameters

• project: string. Project ID or project name
• planId: number.

Returns

• IPromise<Contracts.TestPlan>

getPlanCloneInformation()

Syntax

 IPromise<Contracts.CloneOperationInformation> getPlanCloneInformation(project, operationId, includeDetails)

Parameters

• project: string. Project ID or project name
• operationId: number.
• includeDetails: boolean. Optional.

Returns

• IPromise<Contracts.CloneOperationInformation>

getPlans()

Syntax

 IPromise<Contracts.TestPlan[]> getPlans(project, owner, skip, top, includePlanDetails, filterActivePlans)

Parameters

• project: string. Project ID or project name
• owner: string. Optional.
• skip: number. Optional.
• top: number. Optional.
• includePlanDetails: boolean. Optional.
• filterActivePlans: boolean. Optional.

Returns

• IPromise<Contracts.TestPlan[]>

getPoint()

Syntax

 IPromise<Contracts.TestPoint> getPoint(project, planId, suiteId, pointIds, witFields)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.
• pointIds: number.
• witFields: string. Optional.

Returns

• IPromise<Contracts.TestPoint>

getPoints()

Syntax

 IPromise<Contracts.TestPoint[]> getPoints(project, planId, suiteId, witFields, configurationId, testCaseId, testPointIds, includePointDetails, skip, top)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.
• witFields: string. Optional.
• configurationId: string. Optional.
• testCaseId: string. Optional.
• testPointIds: string. Optional.
• includePointDetails: boolean. Optional.
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestPoint[]>

getResultParameters()

Syntax

 IPromise<Contracts.TestResultParameterModel[]> getResultParameters(project, runId, testCaseResultId, iterationId, paramName)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• iterationId: number.
• paramName: string. Optional.

Returns

• IPromise<Contracts.TestResultParameterModel[]>

getResultRetentionSettings()

Syntax

 IPromise<Contracts.ResultRetentionSettings> getResultRetentionSettings(project)

Parameters

• project: string. Project ID or project name

Returns

• IPromise<Contracts.ResultRetentionSettings>

getSuiteCloneInformation()

Syntax

 IPromise<Contracts.CloneOperationInformation> getSuiteCloneInformation(project, operationId, includeDetails)

Parameters

• project: string. Project ID or project name
• operationId: number.
• includeDetails: boolean. Optional.

Returns

• IPromise<Contracts.CloneOperationInformation>

getSuiteEntries()

Syntax

 IPromise<Contracts.SuiteEntry[]> getSuiteEntries(project, suiteId)

Parameters

• project: string. Project ID or project name
• suiteId: number.

Returns

• IPromise<Contracts.SuiteEntry[]>

getSuitesByTestCaseId()

Syntax

 IPromise<Contracts.TestSuite[]> getSuitesByTestCaseId(testCaseId)

Parameters

• testCaseId: number.

Returns

• IPromise<Contracts.TestSuite[]>

getTestCaseById()

Syntax

 IPromise<Contracts.SuiteTestCase> getTestCaseById(project, planId, suiteId, testCaseIds)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.
• testCaseIds: number.

Returns

• IPromise<Contracts.SuiteTestCase>

getTestCaseResultById()

Syntax

 IPromise<Contracts.TestCaseResult> getTestCaseResultById(project, runId, testCaseResultId, includeIterationDetails, includeAssociatedBugs)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• includeIterationDetails: boolean.
• includeAssociatedBugs: boolean. Optional.

Returns

• IPromise<Contracts.TestCaseResult>

getTestCaseResults()

Syntax

 IPromise<Contracts.TestCaseResult[]> getTestCaseResults(project, runId, includeIterationDetails)

Parameters

• project: string. Project ID or project name
• runId: number.
• includeIterationDetails: boolean.

Returns

• IPromise<Contracts.TestCaseResult[]>

getTestCases()

Syntax

 IPromise<Contracts.SuiteTestCase[]> getTestCases(project, planId, suiteId)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.

Returns

• IPromise<Contracts.SuiteTestCase[]>

getTestConfigurationById()

Syntax

 IPromise<Contracts.TestConfiguration> getTestConfigurationById(project, testConfigurationId)

Parameters

• project: string. Project ID or project name
• testConfigurationId: number.

Returns

• IPromise<Contracts.TestConfiguration>

getTestConfigurations()

Syntax

 IPromise<Contracts.TestConfiguration[]> getTestConfigurations(project, skip, top)

Parameters

• project: string. Project ID or project name
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestConfiguration[]>

getTestIteration()

Syntax

 IPromise<Contracts.TestIterationDetailsModel> getTestIteration(project, runId, testCaseResultId, iterationId, includeActionResults)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• iterationId: number.
• includeActionResults: boolean. Optional.

Returns

• IPromise<Contracts.TestIterationDetailsModel>

getTestIterations()

Syntax

 IPromise<Contracts.TestIterationDetailsModel[]> getTestIterations(project, runId, testCaseResultId, includeActionResults)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• includeActionResults: boolean. Optional.

Returns

• IPromise<Contracts.TestIterationDetailsModel[]>

getTestResultAttachmentContent()

Returns a test result attachment

Syntax

 IPromise<ArrayBuffer> getTestResultAttachmentContent(project, runId, testCaseResultId, attachmentId)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• attachmentId: number.

Returns

• IPromise<ArrayBuffer>

getTestResultAttachmentZip()

Returns a test result attachment

Syntax

 IPromise<ArrayBuffer> getTestResultAttachmentZip(project, runId, testCaseResultId, attachmentId)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• attachmentId: number.

Returns

• IPromise<ArrayBuffer>

getTestResultById()

Syntax

 IPromise<Contracts.TestCaseResult[]> getTestResultById(project, runId, testCaseResultId, detailsToInclude)

Parameters

• project: string. Project ID or project name
• runId: number.
• testCaseResultId: number.
• detailsToInclude: Contracts.ResultDetails. Optional.

Returns

• IPromise<Contracts.TestCaseResult[]>

getTestResultDetailsForBuild()

Syntax

 IPromise<Contracts.AggregatedResultsWithDetails> getTestResultDetailsForBuild(project, buildId, sourceWorkflow, groupBy, filter)

Parameters

• project: string. Project ID or project name
• buildId: number.
• sourceWorkflow: string.
• groupBy: string. Optional.
• filter: string. Optional.

Returns

• IPromise<Contracts.AggregatedResultsWithDetails>

getTestResults()

Syntax

 IPromise<Contracts.TestCaseResult[]> getTestResults(project, runId, detailsToInclude, skip, top)

Parameters

• project: string. Project ID or project name
• runId: number.
• detailsToInclude: Contracts.ResultDetails. Optional.
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestCaseResult[]>

getTestResultsByIds()

Syntax

 IPromise<Contracts.TestCaseResult[]> getTestResultsByIds(ids, project, fields)

Parameters

• ids: Contracts.TestCaseResultIdentifier[].
• project: string.
• fields: string[].

Returns

• IPromise<Contracts.TestCaseResult[]>

getTestResultsByQuery()

Syntax

 IPromise<Contracts.TestCaseResult[]> getTestResultsByQuery(query, project, includeResultDetails, includeIterationDetails, skip, top)

Parameters

• query: Contracts.QueryModel.
• project: string.
• includeResultDetails: boolean. Optional.
• includeIterationDetails: boolean. Optional.
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestCaseResult[]>

getTestRunAttachmentContent()

Returns a test run attachment

Syntax

 IPromise<ArrayBuffer> getTestRunAttachmentContent(project, runId, attachmentId)

Parameters

• project: string. Project ID or project name
• runId: number.
• attachmentId: number.

Returns

• IPromise<ArrayBuffer>

getTestRunAttachmentZip()

Returns a test run attachment

Syntax

 IPromise<ArrayBuffer> getTestRunAttachmentZip(project, runId, attachmentId)

Parameters

• project: string. Project ID or project name
• runId: number.
• attachmentId: number.

Returns

• IPromise<ArrayBuffer>

getTestRunById()

Syntax

 IPromise<Contracts.TestRun> getTestRunById(project, runId)

Parameters

• project: string. Project ID or project name
• runId: number.

Returns

• IPromise<Contracts.TestRun>

getTestRunCodeCoverage()

Syntax

 IPromise<Contracts.TestRunCoverage[]> getTestRunCodeCoverage(project, runId, flags)

Parameters

• project: string. Project ID or project name
• runId: number.
• flags: number.

Returns

• IPromise<Contracts.TestRunCoverage[]>

getTestRunLogs()

Syntax

 IPromise<Contracts.TestMessageLogDetails[]> getTestRunLogs(project, runId)

Parameters

• project: string. Project ID or project name
• runId: number.

Returns

• IPromise<Contracts.TestMessageLogDetails[]>

getTestRuns()

Syntax

 IPromise<Contracts.TestRun[]> getTestRuns(project, buildUri, owner, tmiRunId, planId, includeRunDetails, automated, skip, top)

Parameters

• project: string. Project ID or project name
• buildUri: string. Optional.
• owner: string. Optional.
• tmiRunId: string. Optional.
• planId: number. Optional.
• includeRunDetails: boolean. Optional.
• automated: boolean. Optional.
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestRun[]>

getTestRunsByQuery()

Syntax

 IPromise<Contracts.TestRun[]> getTestRunsByQuery(query, project, includeRunDetails, skip, top)

Parameters

• query: Contracts.QueryModel.
• project: string.
• includeRunDetails: boolean. Optional.
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestRun[]>

getTestRunStatistics()

Syntax

 IPromise<Contracts.TestRunStatistic> getTestRunStatistics(project, runId)

Parameters

• project: string. Project ID or project name
• runId: number.

Returns

• IPromise<Contracts.TestRunStatistic>

getTestSettingsById()

Syntax

 IPromise<Contracts.TestSettings> getTestSettingsById(project, testSettingsId)

Parameters

• project: string. Project ID or project name
• testSettingsId: number.

Returns

• IPromise<Contracts.TestSettings>

getTestSuiteById()

Syntax

 IPromise<Contracts.TestSuite> getTestSuiteById(project, planId, suiteId, includeChildSuites)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.
• includeChildSuites: boolean. Optional.

Returns

• IPromise<Contracts.TestSuite>

getTestSuitesForPlan()

Syntax

 IPromise<Contracts.TestSuite[]> getTestSuitesForPlan(project, planId, includeSuites, skip, top, asTreeView)

Parameters

• project: string. Project ID or project name
• planId: number.
• includeSuites: boolean. Optional.
• skip: number. Optional.
• top: number. Optional.
• asTreeView: boolean. Optional.

Returns

• IPromise<Contracts.TestSuite[]>

getTestSessions()

Syntax

 IPromise<Contracts.TestSessions[]> getTestSessions(teamContext, period, allSessions, includeAllProperties, source, includeOnlyCompletedSessions)

Parameters

• teamContext: string. Project ID or project name
• period: number. Optional.
• allSessions: boolean. Optional.
• includeAllProperties: boolean. Optional.
• source: Contracts.TestSessionSource[]. Optional.
• includeOnlyCompletedSessions: boolean. Optional.

Returns

• IPromise<Contracts.TestSession[]>

getTestVariable()

Syntax

 IPromise<Contracts.TestVariable> getTestVariable(project, testVariableId)

Parameters

• project: string. Project ID or project name
• testVariableId: number.

Returns

• IPromise<Contracts.TestVariable>

getTestVariables()

Syntax

 IPromise<Contracts.TestVariable[]> getTestVariables(project, skip, top)

Parameters

• project: string. Project ID or project name
• skip: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestVariable[]>

queryCustomFields()

Syntax

 IPromise<Contracts.CustomTestFieldDefinition[]> queryCustomFields(project, scopeFilter)

Parameters

• project: string. Project ID or project name
• scopeFilter: Contracts.CustomTestFieldScope.

Returns

• IPromise<Contracts.CustomTestFieldDefinition[]>

queryFailureDetailsForBuild()

Syntax

 IPromise<Contracts.TestFailuresAnalysis> queryFailureDetailsForBuild(build, project, sourceWorkflow, buildToCompare)

Parameters

• build: Contracts.BuildReference.
• project: string.
• sourceWorkflow: string.
• buildToCompare: Contracts.BuildReference.

Returns

• IPromise<Contracts.TestFailuresAnalysis>

queryFailureDetailsForTestRun()

Syntax

 IPromise<Contracts.TestFailuresAnalysis> queryFailureDetailsForTestRun(project, testRunId)

Parameters

• project: string. Project ID or project name
• testRunId: number.

Returns

• IPromise<Contracts.TestFailuresAnalysis>

queryReportForBuild()

Syntax

 IPromise<Contracts.TestReport> queryReportForBuild(project, buildId, sourceWorkflow, includeFailureDetails, buildToCompare)

Parameters

• project: string. Project ID or project name
• buildId: number.
• sourceWorkflow: string.
• includeFailureDetails: boolean.
• buildToCompare: Contracts.BuildReference.

Returns

• IPromise<Contracts.TestReport>

queryResultTrendForBuild()

Syntax

 IPromise<Contracts.AggregatedResultsForBuild[]> queryResultTrendForBuild(filter, project, buildCount)

Parameters

• filter: Contracts.TestResultTrendFilter.
• project: string.
• buildCount: number. Optional.

Returns

• IPromise<Contracts.AggregatedResultsForBuild[]>

queryTestResultRecentBugs()

Syntax

 IPromise<Contracts.WorkItemReference[]> queryTestResultRecentBugs(project, testRunId, testResultId, recentDays)

Parameters

• project: string. Project ID or project name
• testRunId: number.
• testResultId: number.
• recentDays: number. Optional.

Returns

• IPromise<Contracts.WorkItemReference[]>

queryTestResultTrendReport()

Syntax

 IPromise<Contracts.TestCaseResult[]> queryTestResultTrendReport(project, testRunId, testResultId, historyDays, top)

Parameters

• project: string. Project ID or project name
• testRunId: number.
• testResultId: number.
• historyDays: number. Optional.
• top: number. Optional.

Returns

• IPromise<Contracts.TestCaseResult[]>

removeTestCasesFromSuiteUrl()

Syntax

 IPromise<void> removeTestCasesFromSuiteUrl(project, planId, suiteId, testCaseIds)

Parameters

• project: string. Project ID or project name
• planId: number.
• suiteId: number.
• testCaseIds: string.

Returns

• IPromise<void>

reorderSuiteEntries()

Syntax

 IPromise<Contracts.SuiteEntry[]> reorderSuiteEntries(suiteEntries, project, suiteId)

Parameters

• suiteEntries: Contracts.SuiteEntryUpdateModel[].
• project: string. Project ID or project name
• suiteId: number.

Returns

• IPromise<Contracts.SuiteEntry[]>

updateCodeCoverageSummary()

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

Syntax

 IPromise<void> updateCodeCoverageSummary(coverageData, project, buildId)

Parameters

• coverageData: Contracts.CodeCoverageData.
• project: string.
• buildId: number.

Returns

• IPromise<void>

updateResultRetentionSettings()

Syntax

 IPromise<Contracts.ResultRetentionSettings> updateResultRetentionSettings(retentionSettings, project)

Parameters

• retentionSettings: Contracts.ResultRetentionSettings.
• project: string.

Returns

• IPromise<Contracts.ResultRetentionSettings>

updateTestConfiguration()

Syntax

 IPromise<Contracts.TestConfiguration> updateTestConfiguration(testConfiguration, project, testConfigurationId)

Parameters

• testConfiguration: Contracts.TestConfiguration.
• project: string.
• testConfigurationId: number.

Returns

• IPromise<Contracts.TestConfiguration>

updateTestPlan()

Syntax

 IPromise<Contracts.TestPlan> updateTestPlan(planUpdateModel, project, planId)

Parameters

• planUpdateModel: Contracts.PlanUpdateModel.
• project: string.
• planId: number.

Returns

• IPromise<Contracts.TestPlan>

updateTestPoints()

Syntax

 IPromise<Contracts.TestPoint[]> updateTestPoints(pointUpdateModel, project, planId, suiteId, pointIds)

Parameters

• pointUpdateModel: Contracts.PointUpdateModel.
• project: string.
• planId: number.
• suiteId: number.
• pointIds: string.

Returns

• IPromise<Contracts.TestPoint[]>

updateTestResults()

Syntax

 IPromise<Contracts.TestCaseResult[]> updateTestResults(resultUpdateModels, project, runId)

Parameters

• resultUpdateModels: Contracts.TestCaseResultUpdateModel[].
• project: string.
• runId: number.

Returns

• IPromise<Contracts.TestCaseResult[]>

updateTestRun()

Syntax

 IPromise<Contracts.TestRun> updateTestRun(runUpdateModel, project, runId)

Parameters

• runUpdateModel: Contracts.RunUpdateModel.
• project: string.
• runId: number.

Returns

• IPromise<Contracts.TestRun>

updateTestSuite()

Syntax

 IPromise<Contracts.TestSuite> updateTestSuite(suiteUpdateModel, project, planId, suiteId)

Parameters

• suiteUpdateModel: Contracts.SuiteUpdateModel.
• project: string.
• planId: number.
• suiteId: number.

Returns

• IPromise<Contracts.TestSuite>

updateTestSession()

Syntax

 IPromise<Contracts.TestSession> updateTestSession(testSession, teamContext)

Parameters

• testSession: Contracts.TestSession.
• teamContext: Contracts.TeamContext.

Returns

• IPromise<Contracts.TestSession>

updateTestVariable()

Syntax

 IPromise<Contracts.TestVariable> updateTestVariable(testVariable, project, testVariableId)

Parameters

• testVariable: Contracts.TestVariable.
• project: string.
• testVariableId: number.

Returns

• IPromise<Contracts.TestVariable>