Class TestApi

constructor

• new TestApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): TestApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns TestApi

Static ReadonlyRESOURCE_AREA_ID

addCustomFields

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

  Parameters

  • newFields: CustomTestFieldDefinition[]
  • project: string

    Project ID or project name

  Returns Promise<CustomTestFieldDefinition[]>

addTestCasesToSuite

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

  Add test cases to suite.

  Parameters

  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan that contains the suite.
  • suiteId: number

    ID of the test suite to which the test cases must be added.
  • testCaseIds: string

    IDs of the test cases to add to the suite. Ids are specified in comma separated format.

  Returns Promise<SuiteTestCase[]>

addTestResultsToTestRun

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

  Add test results to a test run.

  Parameters

  • results: TestCaseResult[]

    List of test results to add.
  • project: string

    Project ID or project name
  • runId: number

    Test run ID into which test results to add.

  Returns Promise<TestCaseResult[]>

addWorkItemToTestLinks

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

  Parameters

  • workItemToTestLinks: WorkItemToTestLinks
  • project: string

    Project ID or project name

  Returns Promise<WorkItemToTestLinks>

createTestIterationResultAttachment

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

  Attach a file to test step result

  Parameters

  • attachmentRequestModel: TestAttachmentRequestModel

    Attachment details TestAttachmentRequestModel
  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test result that contains the iteration
  • iterationId: number

    ID of the test result iteration.
  • OptionalactionPath: string

    Hex value of test result action path.

  Returns Promise<TestAttachmentReference>

createTestResultAttachment

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

  Attach a file to a test result.

  Parameters

  • attachmentRequestModel: TestAttachmentRequestModel

    Attachment details TestAttachmentRequestModel
  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test result against which attachment has to be uploaded.

  Returns Promise<TestAttachmentReference>

createTestRun

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

  Create new test run.

  Parameters

  • testRun: RunCreateModel

    Run details RunCreateModel
  • project: string

    Project ID or project name

  Returns Promise<TestRun>

createTestRunAttachment

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

  Attach a file to a test run.

  Parameters

  • attachmentRequestModel: TestAttachmentRequestModel

    Attachment details TestAttachmentRequestModel
  • project: string

    Project ID or project name
  • runId: number

    ID of the test run against which attachment has to be uploaded.

  Returns Promise<TestAttachmentReference>

createTestSession

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

  Create a test session

  Parameters

  • testSession: TestSession

    Test session details for creation
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TestSession>

createTestSettings

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

  Parameters

  • testSettings: TestSettings
  • project: string

    Project ID or project name

  Returns Promise<number>

createTestSubResultAttachment

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

  Attach a file to a test result

  Parameters

  • attachmentRequestModel: TestAttachmentRequestModel

    Attachment Request Model.
  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test results that contains sub result.
  • testSubResultId: number

    ID of the test sub results against which attachment has to be uploaded.

  Returns Promise<TestAttachmentReference>

deleteSharedParameter

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

  Parameters

  • project: string

    Project ID or project name
  • sharedParameterId: number

  Returns Promise<void>

deleteSharedStep

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

  Parameters

  • project: string

    Project ID or project name
  • sharedStepId: number

  Returns Promise<void>

deleteTestCase

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

  Delete a test case.

  Parameters

  • project: string

    Project ID or project name
  • testCaseId: number

    Id of test case to delete.

  Returns Promise<void>

deleteTestMethodToWorkItemLink

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

  Parameters

  • project: string

    Project ID or project name
  • testName: string
  • workItemId: number

  Returns Promise<boolean>

deleteTestRun

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

  Delete a test run by its ID.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the run to delete.

  Returns Promise<void>

deleteTestSettings

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

  Parameters

  • project: string

    Project ID or project name
  • testSettingsId: number

  Returns Promise<void>

getBugsLinkedToTestResult

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

  Parameters

  • project: string

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

  Returns Promise<WorkItemReference[]>

getBuildCodeCoverage

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

  Get code coverage data for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    ID of the build for which code coverage data needs to be fetched.
  • flags: number

    Value of flags determine the level of code coverage details to be fetched. Flags are additive. Expected Values are 1 for Modules, 2 for Functions, 4 for BlockData.

  Returns Promise<BuildCoverage[]>

getCodeCoverageSummary

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

  Get Code Coverage Summary for Build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    ID of the build for which code coverage data needs to be fetched.
  • OptionaldeltaBuildId: number

    Delta Build id (optional)

  Returns Promise<CodeCoverageSummary>

getLinkedWorkItemsByQuery

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

  Parameters

  • workItemQuery: LinkedWorkItemsQuery
  • project: string

    Project ID or project name

  Returns Promise<LinkedWorkItemsQueryResult[]>

getPoint

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

  Get a test point.

  Parameters

  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan.
  • suiteId: number

    ID of the suite that contains the point.
  • pointIds: number

    ID of the test point to get.
  • OptionalwitFields: string

    Comma-separated list of work item field names.

  Returns Promise<TestPoint>

getPoints

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

  Get a list of test points.

  Parameters

  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan.
  • suiteId: number

    ID of the suite that contains the points.
  • OptionalwitFields: string

    Comma-separated list of work item field names.
  • OptionalconfigurationId: string

    Get test points for specific configuration.
  • OptionaltestCaseId: string

    Get test points for a specific test case, valid when configurationId is not set.
  • OptionaltestPointIds: string

    Get test points for comma-separated list of test point IDs, valid only when configurationId and testCaseId are not set.
  • OptionalincludePointDetails: boolean

    Include all properties for the test point.
  • Optionalskip: number

    Number of test points to skip..
  • Optionaltop: number

    Number of test points to return.

  Returns Promise<TestPoint[]>

getPointsByQuery

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

  Get test points using query.

  Parameters

  • query: TestPointsQuery

    TestPointsQuery to get test points.
  • project: string

    Project ID or project name
  • Optionalskip: number

    Number of test points to skip..
  • Optionaltop: number

    Number of test points to return.

  Returns Promise<TestPointsQuery>

getResultGroupsByBuild

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

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • publishContext: string
  • Optionalfields: string[]
  • OptionalcontinuationToken: string

  Returns Promise<PagedList<FieldDetailsForTestResults>>

getResultGroupsByRelease

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

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • publishContext: string
  • OptionalreleaseEnvId: number
  • Optionalfields: string[]
  • OptionalcontinuationToken: string

  Returns Promise<PagedList<FieldDetailsForTestResults>>

getResultRetentionSettings

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

  Get test result retention settings

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ResultRetentionSettings>

getTestCaseById

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

  Get a specific test case in a test suite with test case id.

  Parameters

  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan that contains the suites.
  • suiteId: number

    ID of the suite that contains the test case.
  • testCaseIds: number

    ID of the test case to get.

  Returns Promise<SuiteTestCase>

getTestCases

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

  Get all test cases in a suite.

  Parameters

  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan that contains the suites.
  • suiteId: number

    ID of the suite to get.

  Returns Promise<SuiteTestCase[]>

getTestIteration

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

  Get iteration for a result

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test result that contains the iterations.
  • iterationId: number

    Id of the test results Iteration.
  • OptionalincludeActionResults: boolean

    Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

  Returns Promise<TestIterationDetailsModel>

getTestIterations

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

  Get iterations for a result

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test result that contains the iterations.
  • OptionalincludeActionResults: boolean

    Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

  Returns Promise<TestIterationDetailsModel[]>

getTestResultAttachmentContent

• getTestResultAttachmentContent(
      project: string,
      runId: number,
      testCaseResultId: number,
      attachmentId: number,
  ): Promise<ReadableStream>

  Download a test result attachment by its ID.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the testCaseResultId.
  • testCaseResultId: number

    ID of the test result whose attachment has to be downloaded.
  • attachmentId: number

    ID of the test result attachment to be downloaded.

  Returns Promise<ReadableStream>

getTestResultAttachments

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

  Get list of test result attachments reference.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test result.

  Returns Promise<TestAttachment[]>

getTestResultAttachmentZip

• getTestResultAttachmentZip(
      project: string,
      runId: number,
      testCaseResultId: number,
      attachmentId: number,
  ): Promise<ReadableStream>

  Download a test result attachment by its ID.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the testCaseResultId.
  • testCaseResultId: number

    ID of the test result whose attachment has to be downloaded.
  • attachmentId: number

    ID of the test result attachment to be downloaded.

  Returns Promise<ReadableStream>

getTestResultById

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

  Get a test result for a test run.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    Test run ID of a test result to fetch.
  • testCaseResultId: number

    Test result ID.
  • OptionaldetailsToInclude: ResultDetails

    Details to include with test results. Default is None. Other values are Iterations, WorkItems and SubResults.

  Returns Promise<TestCaseResult>

getTestResultDetailsForBuild

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

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionalpublishContext: string
  • OptionalgroupBy: string
  • Optionalfilter: string
  • Optionalorderby: string
  • OptionalshouldIncludeResults: boolean
  • OptionalqueryRunSummaryForInProgress: boolean

  Returns Promise<TestResultsDetails>

getTestResultDetailsForRelease

• 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 or project name
  • releaseId: number
  • releaseEnvId: number
  • OptionalpublishContext: string
  • OptionalgroupBy: string
  • Optionalfilter: string
  • Optionalorderby: string
  • OptionalshouldIncludeResults: boolean
  • OptionalqueryRunSummaryForInProgress: boolean

  Returns Promise<TestResultsDetails>

getTestResults

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

  Get test results for a test run.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    Test run ID of test results to fetch.
  • OptionaldetailsToInclude: ResultDetails

    Details to include with test results. Default is None. Other values are Iterations and WorkItems.
  • Optionalskip: number

    Number of test results to skip from beginning.
  • Optionaltop: number

    Number of test results to return. Maximum is 1000 when detailsToInclude is None and 200 otherwise.
  • Optionaloutcomes: TestOutcome[]

    Comma separated list of test outcomes to filter test results.

  Returns Promise<TestCaseResult[]>

getTestResultsByBuild

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

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionalpublishContext: string
  • Optionaloutcomes: TestOutcome[]
  • Optionaltop: number
  • OptionalcontinuationToken: string

  Returns Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByQuery

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

  This API will return results by Ids with fields specified/trend for particular automated test method. We are still improving this API and have not finalized proper signature and contract.

  Parameters

  • query: TestResultsQuery
  • project: string

    Project ID or project name

  Returns Promise<TestResultsQuery>

getTestResultsByRelease

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

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • OptionalreleaseEnvid: number
  • OptionalpublishContext: string
  • Optionaloutcomes: TestOutcome[]
  • Optionaltop: number
  • OptionalcontinuationToken: string

  Returns Promise<PagedList<ShallowTestCaseResult>>

getTestRunAttachmentContent

• getTestRunAttachmentContent(
      project: string,
      runId: number,
      attachmentId: number,
  ): Promise<ReadableStream>

  Download a test run attachment by its ID.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run whose attachment has to be downloaded.
  • attachmentId: number

    ID of the test run attachment to be downloaded.

  Returns Promise<ReadableStream>

getTestRunAttachments

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

  Get list of test run attachments reference.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run.

  Returns Promise<TestAttachment[]>

getTestRunAttachmentZip

• getTestRunAttachmentZip(
      project: string,
      runId: number,
      attachmentId: number,
  ): Promise<ReadableStream>

  Download a test run attachment by its ID.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run whose attachment has to be downloaded.
  • attachmentId: number

    ID of the test run attachment to be downloaded.

  Returns Promise<ReadableStream>

getTestRunById

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

  Get a test run by its ID.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the run to get.
  • OptionalincludeDetails: boolean

    Default value is true. It includes details like run statistics, release, build, test environment, post process state, and more.

  Returns Promise<TestRun>

getTestRunCodeCoverage

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

  Get code coverage data for a test run

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run for which code coverage data needs to be fetched.
  • flags: number

    Value of flags determine the level of code coverage details to be fetched. Flags are additive. Expected Values are 1 for Modules, 2 for Functions, 4 for BlockData.

  Returns Promise<TestRunCoverage[]>

getTestRunLogs

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

  Get test run message logs

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the run to get.

  Returns Promise<TestMessageLogDetails[]>

getTestRuns

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

  Get a list of test runs.

  Parameters

  • project: string

    Project ID or project name
  • OptionalbuildUri: string

    URI of the build that the runs used.
  • Optionalowner: string

    Team foundation ID of the owner of the runs.
  • OptionaltmiRunId: string
  • OptionalplanId: number

    ID of the test plan that the runs are a part of.
  • OptionalincludeRunDetails: boolean

    If true, include all the properties of the runs.
  • Optionalautomated: boolean

    If true, only returns automated runs.
  • Optionalskip: number

    Number of test runs to skip.
  • Optionaltop: number

    Number of test runs to return.

  Returns Promise<TestRun[]>

getTestRunStatistics

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

  Get test run statistics , used when we want to get summary of a run by outcome.

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the run to get.

  Returns Promise<TestRunStatistic>

getTestSessions

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

  Get a list of test sessions

  Parameters

  • teamContext: TeamContext

    The team context for the operation
  • Optionalperiod: number

    Period in days from now, for which test sessions are fetched.
  • OptionalallSessions: boolean

    If false, returns test sessions for current user. Otherwise, it returns test sessions for all users
  • OptionalincludeAllProperties: boolean

    If true, it returns all properties of the test sessions. Otherwise, it returns the skinny version.
  • Optionalsource: TestSessionSource

    Source of the test session.
  • OptionalincludeOnlyCompletedSessions: boolean

    If true, it returns test sessions in completed state. Otherwise, it returns test sessions for all states

  Returns Promise<TestSession[]>

getTestSettingsById

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

  Parameters

  • project: string

    Project ID or project name
  • testSettingsId: number

  Returns Promise<TestSettings>

getTestSubResultAttachmentContent

• getTestSubResultAttachmentContent(
      project: string,
      runId: number,
      testCaseResultId: number,
      attachmentId: number,
      testSubResultId: number,
  ): Promise<ReadableStream>

  Download a test sub result attachment

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test results that contains sub result.
  • attachmentId: number

    ID of the test result attachment to be downloaded
  • testSubResultId: number

    ID of the test sub result whose attachment has to be downloaded

  Returns Promise<ReadableStream>

getTestSubResultAttachments

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

  Get list of test sub result attachments

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test results that contains sub result.
  • testSubResultId: number

    ID of the test sub result whose attachment has to be downloaded

  Returns Promise<TestAttachment[]>

getTestSubResultAttachmentZip

• getTestSubResultAttachmentZip(
      project: string,
      runId: number,
      testCaseResultId: number,
      attachmentId: number,
      testSubResultId: number,
  ): Promise<ReadableStream>

  Download a test sub result attachment

  Parameters

  • project: string

    Project ID or project name
  • runId: number

    ID of the test run that contains the result.
  • testCaseResultId: number

    ID of the test results that contains sub result.
  • attachmentId: number

    ID of the test result attachment to be downloaded
  • testSubResultId: number

    ID of the test sub result whose attachment has to be downloaded

  Returns Promise<ReadableStream>

publishTestResultDocument

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

  Parameters

  • document: TestResultDocument
  • project: string

    Project ID or project name
  • runId: number

  Returns Promise<TestResultDocument>

queryCustomFields

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

  Parameters

  • project: string

    Project ID or project name
  • scopeFilter: CustomTestFieldScope

  Returns Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild

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

  Parameters

  • filter: TestResultTrendFilter
  • project: string

    Project ID or project name

  Returns Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease

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

  Parameters

  • filter: TestResultTrendFilter
  • project: string

    Project ID or project name

  Returns Promise<AggregatedDataForResultTrend[]>

queryTestHistory

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

  Get history of a test method using TestHistoryQuery

  Parameters

  • filter: TestHistoryQuery

    TestHistoryQuery to get history
  • project: string

    Project ID or project name

  Returns Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems

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

  Parameters

  • project: string

    Project ID or project name
  • testName: string

  Returns Promise<TestToWorkItemLinks>

queryTestResultHistory

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

  Parameters

  • filter: ResultsFilter
  • project: string

    Project ID or project name

  Returns Promise<TestResultHistory>

queryTestResultsMetaData

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

  Get list of test Result meta data details for corresponding testcasereferenceId

  Parameters

  • testReferenceIds: string[]

    TestCaseReference Ids of the test Result to be queried, comma separated list of valid ids (limit no. of ids 200).
  • project: string

    Project ID or project name

  Returns Promise<TestResultMetaData[]>

queryTestResultsReportForBuild

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

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionalpublishContext: string
  • OptionalincludeFailureDetails: boolean
  • OptionalbuildToCompare: BuildReference

  Returns Promise<TestResultSummary>

queryTestResultsReportForRelease

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

  Parameters

  • project: string

    Project ID or project name
  • releaseId: number
  • releaseEnvId: number
  • OptionalpublishContext: string
  • OptionalincludeFailureDetails: boolean
  • OptionalreleaseToCompare: ReleaseReference

  Returns Promise<TestResultSummary>

queryTestResultsSummaryForReleases

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

  Parameters

  • releases: ReleaseReference[]
  • project: string

    Project ID or project name

  Returns Promise<TestResultSummary[]>

queryTestResultWorkItems

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

  Parameters

  • project: string

    Project ID or project name
  • workItemCategory: string
  • OptionalautomatedTestName: string
  • OptionaltestCaseId: number
  • OptionalmaxCompleteDate: Date
  • Optionaldays: number
  • OptionalworkItemCount: number

  Returns Promise<WorkItemReference[]>

queryTestRuns

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

  Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate.

  Parameters

  • project: string

    Project ID or project name
  • minLastUpdatedDate: Date

    Minimum Last Modified Date of run to be queried (Mandatory).
  • maxLastUpdatedDate: Date

    Maximum Last Modified Date of run to be queried (Mandatory, difference between min and max date can be atmost 7 days).
  • Optionalstate: TestRunState

    Current state of the Runs to be queried.
  • OptionalplanIds: number[]

    Plan Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalisAutomated: boolean

    Automation type of the Runs to be queried.
  • OptionalpublishContext: TestRunPublishContext

    PublishContext of the Runs to be queried.
  • OptionalbuildIds: number[]

    Build Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalbuildDefIds: number[]

    Build Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalbranchName: string

    Source Branch name of the Runs to be queried.
  • OptionalreleaseIds: number[]

    Release Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalreleaseDefIds: number[]

    Release Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalreleaseEnvIds: number[]

    Release Environment Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalreleaseEnvDefIds: number[]

    Release Environment Definition Ids of the Runs to be queried, comma separated list of valid ids (limit no. of ids 10).
  • OptionalrunTitle: string

    Run Title of the Runs to be queried.
  • Optionaltop: number

    Number of runs to be queried. Limit is 100
  • OptionalcontinuationToken: string

    continuationToken received from previous batch or null for first batch. It is not supposed to be created (or altered, if received from last batch) by user.

  Returns Promise<PagedList<TestRun>>

queryTestSummaryByRequirement

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

  Parameters

  • resultsContext: TestResultsContext
  • project: string

    Project ID or project name
  • OptionalworkItemIds: number[]

  Returns Promise<TestSummaryForWorkItem[]>

removeTestCasesFromSuiteUrl

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

  The test points associated with the test cases are removed from the test suite. The test case work item is not deleted from the system. See test cases resource to delete a test case permanently.

  Parameters

  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan that contains the suite.
  • suiteId: number

    ID of the suite to get.
  • testCaseIds: string

    IDs of the test cases to remove from the suite.

  Returns Promise<void>

updateCodeCoverageSummary

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

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

  Parameters

  • coverageData: CodeCoverageData
  • project: string

    Project ID or project name
  • buildId: number

  Returns Promise<void>

updateResultRetentionSettings

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

  Update test result retention settings

  Parameters

  • retentionSettings: ResultRetentionSettings

    Test result retention settings details to be updated
  • project: string

    Project ID or project name

  Returns Promise<ResultRetentionSettings>

updateSuiteTestCases

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

  Updates the properties of the test case association in a suite.

  Parameters

  • suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel

    Model for updation of the properties of test case suite association.
  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan that contains the suite.
  • suiteId: number

    ID of the test suite to which the test cases must be added.
  • testCaseIds: string

    IDs of the test cases to add to the suite. Ids are specified in comma separated format.

  Returns Promise<SuiteTestCase[]>

updateTestPoints

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

  Update test points.

  Parameters

  • pointUpdateModel: PointUpdateModel

    Data to update.
  • project: string

    Project ID or project name
  • planId: number

    ID of the test plan.
  • suiteId: number

    ID of the suite that contains the points.
  • pointIds: string

    ID of the test point to get. Use a comma-separated list of IDs to update multiple test points.

  Returns Promise<TestPoint[]>

updateTestResults

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

  Update test results in a test run.

  Parameters

  • results: TestCaseResult[]

    List of test results to update.
  • project: string

    Project ID or project name
  • runId: number

    Test run ID whose test results to update.

  Returns Promise<TestCaseResult[]>

updateTestRun

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

  Update test run by its ID.

  Parameters

  • runUpdateModel: RunUpdateModel

    Run details RunUpdateModel
  • project: string

    Project ID or project name
  • runId: number

    ID of the run to update.

  Returns Promise<TestRun>

updateTestSession

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

  Update a test session

  Parameters

  • testSession: TestSession

    Test session details for update
  • teamContext: TeamContext

    The team context for the operation

  Returns Promise<TestSession>