Class TestResultsApi

Hierarchy (View Summary)

ClientApiBase
- TestResultsApi

Implements

ITestResultsApi

Index

Constructors

constructor

new TestResultsApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): TestResultsApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns TestResultsApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:135

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

`Static` `Readonly`RESOURCE_AREA_ID

RESOURCE_AREA_ID: "c83eaf52-edf3-4034-ae11-17d38f25404c"

Methods

addCustomFields

addCustomFields(
newFields: CustomTestFieldDefinition[],
project: string,
): Promise<CustomTestFieldDefinition[]>
Parameters
- newFields: CustomTestFieldDefinition[]
- project: string
  Project ID or project name
Returns Promise<CustomTestFieldDefinition[]>
Implementation of ITestResultsApi.addCustomFields
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1268

addTestResultsToTestRun

addTestResultsToTestRun(
    results: TestCaseResult[],
    project: string,
    runId: number,
): Promise<TestCaseResult[]>
Parameters
- results: TestCaseResult[]
- project: string
  Project ID or project name
- runId: number
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.addTestResultsToTestRun
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2145

addTestResultsToTestRunSession

addTestResultsToTestRunSession(
    results: TestCaseResult[],
    project: string,
    runId: number,
): Promise<TestCaseResult[]>
Add Test Results to test run session
Parameters
- results: TestCaseResult[]
- project: string
  Project ID or project name
- runId: number
  RunId of test run
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.addTestResultsToTestRunSession
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5398

addWorkItemToTestLinks

addWorkItemToTestLinks(
workItemToTestLinks: WorkItemToTestLinks,
project: string,
): Promise<WorkItemToTestLinks>
Parameters
- workItemToTestLinks: WorkItemToTestLinks
- project: string
  Project ID or project name
Returns Promise<WorkItemToTestLinks>
Implementation of ITestResultsApi.addWorkItemToTestLinks
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5687

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of ITestResultsApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createBuildAttachmentInLogStore

createBuildAttachmentInLogStore(
    attachmentRequestModel: TestAttachmentRequestModel,
    project: string,
    buildId: number,
): Promise<void>
Creates an attachment in the LogStore for the specified buildId.
Parameters
- attachmentRequestModel: TestAttachmentRequestModel
  Contains attachment info like stream, filename, comment, attachmentType
- project: string
  Project ID or project name
- buildId: number
  BuildId
Returns Promise<void>
Implementation of ITestResultsApi.createBuildAttachmentInLogStore
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3875

createEnvironment

createEnvironment(
environments: TestSessionEnvironment[],
project: string,
): Promise<void>
Creates Environment object in TCM data store
Parameters
- environments: TestSessionEnvironment[]
  Received Environment object.
- project: string
  Project ID or project name
Returns Promise<void>
Implementation of ITestResultsApi.createEnvironment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5264

createFailureType

createFailureType(
testResultFailureType: TestResultFailureTypeRequestModel,
project: string,
): Promise<TestResultFailureType>
Creates a new test failure type
Parameters
- testResultFailureType: TestResultFailureTypeRequestModel
- project: string
  Project ID or project name
Returns Promise<TestResultFailureType>
Implementation of ITestResultsApi.createFailureType
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4156

createNotification

createNotification(
    notifications: TestSessionNotification[],
    project: string,
    sessionId: number,
): Promise<number[]>
Creates Notification object in TCM data store for a given session
Parameters
- notifications: TestSessionNotification[]
  Notification(s) to add for the specified sessionId
- project: string
  Project ID or project name
- sessionId: number
  ID of Session to add Notification
Returns Promise<number[]>
Implementation of ITestResultsApi.createNotification
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5308

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of ITestResultsApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

createTestIterationResultAttachment

createTestIterationResultAttachment(
    attachmentRequestModel: TestAttachmentRequestModel,
    project: string,
    runId: number,
    testCaseResultId: number,
    iterationId: number,
    actionPath?: string,
): Promise<TestAttachmentReference>
Parameters
- attachmentRequestModel: TestAttachmentRequestModel
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- iterationId: number
- OptionalactionPath: string
Returns Promise<TestAttachmentReference>
Implementation of ITestResultsApi.createTestIterationResultAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:149

createTestResultAttachment

createTestResultAttachment(
    attachmentRequestModel: TestAttachmentRequestModel,
    project: string,
    runId: number,
    testCaseResultId: number,
): Promise<TestAttachmentReference>
Parameters
- attachmentRequestModel: TestAttachmentRequestModel
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
Returns Promise<TestAttachmentReference>
Implementation of ITestResultsApi.createTestResultAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:207

createTestRun

createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>
Parameters
- testRun: RunCreateModel
- project: string
  Project ID or project name
Returns Promise<TestRun>
Implementation of ITestResultsApi.createTestRun
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2965

createTestRunAttachment

createTestRunAttachment(
    attachmentRequestModel: TestAttachmentRequestModel,
    project: string,
    runId: number,
): Promise<TestAttachmentReference>
Parameters
- attachmentRequestModel: TestAttachmentRequestModel
- project: string
  Project ID or project name
- runId: number
Returns Promise<TestAttachmentReference>
Implementation of ITestResultsApi.createTestRunAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:752

createTestRunLogStoreAttachment

createTestRunLogStoreAttachment(
    attachmentRequestModel: TestAttachmentRequestModel,
    project: string,
    runId: number,
): Promise<TestLogStoreAttachmentReference>
Creates an attachment in the LogStore for the specified runId.
Parameters
- attachmentRequestModel: TestAttachmentRequestModel
  Contains attachment info like stream, filename, comment, attachmentType
- project: string
  Project ID or project name
- runId: number
  Test RunId
Returns Promise<TestLogStoreAttachmentReference>
Implementation of ITestResultsApi.createTestRunLogStoreAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3921

createTestSession

createTestSession(session: TestResultsSession, project: string): Promise<number>
Creates TestResultsSession object in TCM data store
Parameters
- session: TestResultsSession
  Received session object.
- project: string
  Project ID or project name
Returns Promise<number>
Implementation of ITestResultsApi.createTestSession
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5119

createTestSettings

createTestSettings(testSettings: TestSettings, project: string): Promise<number>
Parameters
- testSettings: TestSettings
- project: string
  Project ID or project name
Returns Promise<number>
Implementation of ITestResultsApi.createTestSettings
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5548

createTestSubResultAttachment

createTestSubResultAttachment(
    attachmentRequestModel: TestAttachmentRequestModel,
    project: string,
    runId: number,
    testCaseResultId: number,
    testSubResultId: number,
): Promise<TestAttachmentReference>
Parameters
- attachmentRequestModel: TestAttachmentRequestModel
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- testSubResultId: number
Returns Promise<TestAttachmentReference>
Implementation of ITestResultsApi.createTestSubResultAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:255

deleteFailureType

deleteFailureType(project: string, failureTypeId: number): Promise<void>
Deletes a test failure type with specified failureTypeId
Parameters
- project: string
  Project ID or project name
- failureTypeId: number
Returns Promise<void>
Implementation of ITestResultsApi.deleteFailureType
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4199

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>
Implementation of ITestResultsApi.deleteTestMethodToWorkItemLink
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5729

deleteTestResultAttachment

deleteTestResultAttachment(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
Returns Promise<void>
Implementation of ITestResultsApi.deleteTestResultAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:311

deleteTestRun

deleteTestRun(project: string, runId: number): Promise<void>
Parameters
- project: string
  Project ID or project name
- runId: number
Returns Promise<void>
Implementation of ITestResultsApi.deleteTestRun
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3006

deleteTestRunAttachment

deleteTestRunAttachment(
    project: string,
    runId: number,
    attachmentId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- runId: number
- attachmentId: number
Returns Promise<void>
Implementation of ITestResultsApi.deleteTestRunAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:796

deleteTestRunLogStoreAttachment

deleteTestRunLogStoreAttachment(
    project: string,
    runId: number,
    filename: string,
): Promise<void>
Deletes the attachment with the specified filename for the specified runId from the LogStore.
Parameters
- project: string
  Project ID or project name
- runId: number
  Test RunId
- filename: string
  Attachment FileName
Returns Promise<void>
Implementation of ITestResultsApi.deleteTestRunLogStoreAttachment
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3967

deleteTestSettings

deleteTestSettings(project: string, testSettingsId: number): Promise<void>
Parameters
- project: string
  Project ID or project name
- testSettingsId: number
Returns Promise<void>
Implementation of ITestResultsApi.deleteTestSettings
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5589

fetchSourceCodeCoverageReport

fetchSourceCodeCoverageReport(
project: string,
buildId: number,
): Promise<SourceViewBuildCoverage[]>
Parameters
- project: string
  Project ID or project name
- buildId: number
Returns Promise<SourceViewBuildCoverage[]>
Implementation of ITestResultsApi.fetchSourceCodeCoverageReport
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1005

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of ITestResultsApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

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[]>
Implementation of ITestResultsApi.getBugsLinkedToTestResult
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:961

getBuildCodeCoverage

getBuildCodeCoverage(
    project: string,
    buildId: number,
    flags: number,
): Promise<BuildCoverage[]>
Parameters
- project: string
  Project ID or project name
- buildId: number
- flags: number
Returns Promise<BuildCoverage[]>
Implementation of ITestResultsApi.getBuildCodeCoverage
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1055

getCodeCoverageSummary

getCodeCoverageSummary(
    project: string,
    buildId: number,
    deltaBuildId?: number,
): Promise<CodeCoverageSummary>
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: build id and delta build id (optional)
Parameters
- project: string
  Project ID or project name
- buildId: number
- OptionaldeltaBuildId: number
Returns Promise<CodeCoverageSummary>
Implementation of ITestResultsApi.getCodeCoverageSummary
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1112

getCoverageStatusBadge

getCoverageStatusBadge(
    project: string,
    definition: string,
    branchName?: string,
    label?: string,
): Promise<string>
Gets the coverage status for the last successful build of a definition, optionally scoped to a specific branch
Parameters
- project: string
  Project ID or project name
- definition: string
  The ID or name of the definition.
- OptionalbranchName: string
  The branch name.
- Optionallabel: string
  The String to replace the default text on the left side of the badge.
Returns Promise<string>
Implementation of ITestResultsApi.getCoverageStatusBadge
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3560

getFailureTypes

getFailureTypes(project: string): Promise<TestResultFailureType[]>
Returns the list of test failure types.
Parameters
- project: string
  Project ID or project name
Returns Promise<TestResultFailureType[]>
Implementation of ITestResultsApi.getFailureTypes
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4242

getFileLevelCodeCoverage

getFileLevelCodeCoverage(
fileCoverageRequest: FileCoverageRequest,
project: string,
): Promise<ReadableStream>
Get file coverage for the specified file
Parameters
- fileCoverageRequest: FileCoverageRequest
  File details with pull request iteration context
- project: string
  Project ID or project name
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getFileLevelCodeCoverage
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1360

getFlakyTestResultsByBuildDefinitionId

getFlakyTestResultsByBuildDefinitionId(
    project: string,
    buildDefinitionId: number,
    minBuildCreatedDate: Date,
): Promise<TestCaseResult[]>
Parameters
- project: string
  Project ID or project name
- buildDefinitionId: number
- minBuildCreatedDate: Date
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.getFlakyTestResultsByBuildDefinitionId
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1394

getFlakyTestResultsByTestRun

getFlakyTestResultsByTestRun(
project: string,
runId: number,
): Promise<TestCaseResult[]>
Parameters
- project: string
  Project ID or project name
- runId: number
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.getFlakyTestResultsByTestRun
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1448

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>>
Implementation of ITestResultsApi.getResultGroupsByBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1828

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>>
Implementation of ITestResultsApi.getResultGroupsByRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1890

getSessionNotifications

getSessionNotifications(
project: string,
sessionId: number,
): Promise<TestSessionNotification[]>
Retrieves TestResultsSession Notification objects in TCM data store
Parameters
- project: string
  Project ID or project name
- sessionId: number
  Id of TestResults session to obtain Notifications for.
Returns Promise<TestSessionNotification[]>
Implementation of ITestResultsApi.getSessionNotifications
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5353

getSimilarTestResults

getSimilarTestResults(
    customHeaders: any,
    project: string,
    runId: number,
    testResultId: number,
    testSubResultId: number,
    top?: number,
    continuationToken?: String,
): Promise<TestCaseResult[]>
Gets the list of results whose failure matches with the provided one.
Parameters
- customHeaders: any
- project: string
  Project ID or project name
- runId: number
  id of test run
- testResultId: number
  id of test result inside a test run
- testSubResultId: number
  id of subresult inside a test result
- Optionaltop: number
  Maximum number of results to return
- OptionalcontinuationToken: String
  Header to pass the continuationToken
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.getSimilarTestResults
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3451

getTestIterationAttachmentContent

getTestIterationAttachmentContent(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
    iterationId: number,
): Promise<ReadableStream>
Returns a test iteration attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
- iterationId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestIterationAttachmentContent
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:362

getTestIterationAttachmentZip

getTestIterationAttachmentZip(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
    iterationId: number,
): Promise<ReadableStream>
Returns a test iteration attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
- iterationId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestIterationAttachmentZip
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:414

getTestLogsForBuild

getTestLogsForBuild(
    customHeaders: any,
    project: string,
    buildId: number,
    type: TestLogType,
    directoryPath?: string,
    fileNamePrefix?: string,
    fetchMetaData?: boolean,
    top?: number,
    continuationToken?: String,
): Promise<PagedList<TestLog>>
Get list of build attachments reference
Parameters
- customHeaders: any
- project: string
  Project ID or project name
- buildId: number
  Id of the build to get
- type: TestLogType
  type of the attachment to get
- OptionaldirectoryPath: string
  directory path for which attachments are needed
- OptionalfileNamePrefix: string
  file name prefix to filter the list of attachment
- OptionalfetchMetaData: boolean
  Default is false, set if metadata is needed
- Optionaltop: number
  Number of test attachments reference to return
- OptionalcontinuationToken: String
  Header to pass the continuationToken
Returns Promise<PagedList<TestLog>>
Implementation of ITestResultsApi.getTestLogsForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4333

getTestLogStoreEndpointDetailsForBuildLog

getTestLogStoreEndpointDetailsForBuildLog(
    project: string,
    build: number,
    type: TestLogType,
    filePath: string,
): Promise<TestLogStoreEndpointDetails>
Get SAS Uri of a build attachment
Parameters
- project: string
  Project ID or project name
- build: number
  Id of the build to get
- type: TestLogType
  type of the file
- filePath: string
  filePath for which sas uri is needed
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.getTestLogStoreEndpointDetailsForBuildLog
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4636

getTestLogStoreEndpointDetailsForResultLog

getTestLogStoreEndpointDetailsForResultLog(
    project: string,
    runId: number,
    resultId: number,
    type: TestLogType,
    filePath: string,
): Promise<TestLogStoreEndpointDetails>
Get SAS Uri of a test results attachment
Parameters
- project: string
  Project ID or project name
- runId: number
  Id of the test run that contains result
- resultId: number
  Id of the test result whose files need to be downloaded
- type: TestLogType
  type of the file
- filePath: string
  filePath for which sas uri is needed
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.getTestLogStoreEndpointDetailsForResultLog
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4757

getTestLogStoreEndpointDetailsForRunLog

getTestLogStoreEndpointDetailsForRunLog(
    project: string,
    runId: number,
    type: TestLogType,
    filePath: string,
): Promise<TestLogStoreEndpointDetails>
Get SAS Uri of a test run attachment
Parameters
- project: string
  Project ID or project name
- runId: number
  Id of the test run whose file has to be downloaded
- type: TestLogType
  type of the file
- filePath: string
  filePath for which sas uri is needed
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.getTestLogStoreEndpointDetailsForRunLog
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4957

getTestLogStoreEndpointDetailsForSubResultLog

getTestLogStoreEndpointDetailsForSubResultLog(
    project: string,
    runId: number,
    resultId: number,
    subResultId: number,
    type: TestLogType,
    filePath: string,
): Promise<TestLogStoreEndpointDetails>
Get SAS Uri of a test subresults attachment
Parameters
- project: string
  Project ID or project name
- runId: number
  Id of the test run that contains result
- resultId: number
  Id of the test result that contains subresult
- subResultId: number
  Id of the test subresult whose file sas uri is needed
- type: TestLogType
  type of the file
- filePath: string
  filePath for which sas uri is needed
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.getTestLogStoreEndpointDetailsForSubResultLog
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4821

getTestPipelineMetrics

getTestPipelineMetrics(
    project: string,
    pipelineId: number,
    stageName?: string,
    phaseName?: string,
    jobName?: string,
    metricNames?: Metrics[],
    groupByNode?: boolean,
): Promise<PipelineTestMetrics>
Get summary of test results.
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  Pipeline Id. This is same as build Id.
- OptionalstageName: string
  Name of the stage. Maximum supported length for name is 256 character.
- OptionalphaseName: string
  Name of the phase. Maximum supported length for name is 256 character.
- OptionaljobName: string
  Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
- OptionalmetricNames: Metrics[]
- OptionalgroupByNode: boolean
  Group summary for each node of the pipleine heirarchy
Returns Promise<PipelineTestMetrics>
Implementation of ITestResultsApi.getTestPipelineMetrics
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1582

getTestResultAttachmentContent

getTestResultAttachmentContent(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
): Promise<ReadableStream>
Returns a test result attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestResultAttachmentContent
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:465

getTestResultAttachments

getTestResultAttachments(
    project: string,
    runId: number,
    testCaseResultId: number,
): Promise<TestAttachment[]>
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
Returns Promise<TestAttachment[]>
Implementation of ITestResultsApi.getTestResultAttachments
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:504

getTestResultAttachmentZip

getTestResultAttachmentZip(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
): Promise<ReadableStream>
Returns a test result attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestResultAttachmentZip
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:552

getTestResultById

getTestResultById(
    project: string,
    runId: number,
    testResultId: number,
    detailsToInclude?: ResultDetails,
): Promise<TestCaseResult>
Parameters
- project: string
  Project ID or project name
- runId: number
- testResultId: number
- OptionaldetailsToInclude: ResultDetails
Returns Promise<TestCaseResult>
Implementation of ITestResultsApi.getTestResultById
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2190

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>
Implementation of ITestResultsApi.getTestResultDetailsForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1647

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>
Implementation of ITestResultsApi.getTestResultDetailsForRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1715

getTestResultLogs

getTestResultLogs(
    customHeaders: any,
    project: string,
    runId: number,
    resultId: number,
    type: TestLogType,
    directoryPath?: string,
    fileNamePrefix?: string,
    fetchMetaData?: boolean,
    top?: number,
    continuationToken?: String,
): Promise<PagedList<TestLog>>
Get list of test result attachments reference
Parameters
- customHeaders: any
- project: string
  Project ID or project name
- runId: number
  Id of the test run that contains the result
- resultId: number
  Id of the test result
- type: TestLogType
  type of attachments to get
- OptionaldirectoryPath: string
  directory path of attachments to get
- OptionalfileNamePrefix: string
  file name prefix to filter the list of attachment
- OptionalfetchMetaData: boolean
  Default is false, set if metadata is needed
- Optionaltop: number
  Numbe of attachments reference to return
- OptionalcontinuationToken: String
  Header to pass the continuationToken
Returns Promise<PagedList<TestLog>>
Implementation of ITestResultsApi.getTestResultLogs
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4410

getTestResults

getTestResults(
    project: string,
    runId: number,
    detailsToInclude?: ResultDetails,
    skip?: number,
    top?: number,
    outcomes?: TestOutcome[],
    newTestsOnly?: boolean,
): Promise<TestCaseResult[]>
Parameters
- project: string
  Project ID or project name
- runId: number
- OptionaldetailsToInclude: ResultDetails
- Optionalskip: number
- Optionaltop: number
- Optionaloutcomes: TestOutcome[]
- OptionalnewTestsOnly: boolean
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.getTestResults
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2245

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>>
Implementation of ITestResultsApi.getTestResultsByBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2349

getTestResultsByPipeline

getTestResultsByPipeline(
    customHeaders: any,
    project: string,
    pipelineId: number,
    stageName?: string,
    phaseName?: string,
    jobName?: string,
    outcomes?: TestOutcome[],
    top?: number,
    continuationToken?: String,
): Promise<PagedList<ShallowTestCaseResult>>
Get a list of results.
Parameters
- customHeaders: any
- project: string
  Project ID or project name
- pipelineId: number
  Pipeline Id. This is same as build Id.
- OptionalstageName: string
  Name of the stage. Maximum supported length for name is 256 character.
- OptionalphaseName: string
  Name of the phase. Maximum supported length for name is 256 character.
- OptionaljobName: string
  Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
- Optionaloutcomes: TestOutcome[]
  List of outcome of results
- Optionaltop: number
  Maximum number of results to return
- OptionalcontinuationToken: String
  Header to pass the continuationToken
Returns Promise<PagedList<ShallowTestCaseResult>>
Implementation of ITestResultsApi.getTestResultsByPipeline
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2414

getTestResultsByQuery

getTestResultsByQuery(
query: TestResultsQuery,
project: string,
): Promise<TestResultsQuery>
Parameters
- query: TestResultsQuery
- project: string
  Project ID or project name
Returns Promise<TestResultsQuery>
Implementation of ITestResultsApi.getTestResultsByQuery
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2046

getTestResultsByQueryWiql

getTestResultsByQueryWiql(
    queryModel: QueryModel,
    project: string,
    includeResultDetails?: boolean,
    includeIterationDetails?: boolean,
    skip?: number,
    top?: number,
): Promise<TestCaseResult[]>
Parameters
- queryModel: QueryModel
- project: string
  Project ID or project name
- OptionalincludeResultDetails: boolean
- OptionalincludeIterationDetails: boolean
- Optionalskip: number
- Optionaltop: number
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.getTestResultsByQueryWiql
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2091

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>>
Implementation of ITestResultsApi.getTestResultsByRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2484

getTestResultsSettings

getTestResultsSettings(
project: string,
settingsType?: TestResultsSettingsType,
): Promise<TestResultsSettings>
Get TestResultsSettings data
Parameters
- project: string
  Project ID or project name
- OptionalsettingsType: TestResultsSettingsType
Returns Promise<TestResultsSettings>
Implementation of ITestResultsApi.getTestResultsSettings
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3356

getTestResultWorkItemsById

getTestResultWorkItemsById(
    project: string,
    runId: number,
    testCaseResultId: number,
): Promise<WorkItemReference[]>
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
Returns Promise<WorkItemReference[]>
Implementation of ITestResultsApi.getTestResultWorkItemsById
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5833

getTestRunAttachmentContent

getTestRunAttachmentContent(
    project: string,
    runId: number,
    attachmentId: number,
): Promise<ReadableStream>
Returns a test run attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- attachmentId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestRunAttachmentContent
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:843

getTestRunAttachments

getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>
Parameters
- project: string
  Project ID or project name
- runId: number
Returns Promise<TestAttachment[]>
Implementation of ITestResultsApi.getTestRunAttachments
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:879

getTestRunAttachmentZip

getTestRunAttachmentZip(
    project: string,
    runId: number,
    attachmentId: number,
): Promise<ReadableStream>
Returns a test run attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- attachmentId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestRunAttachmentZip
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:924

getTestRunById

getTestRunById(
    project: string,
    runId: number,
    includeDetails?: boolean,
    includeTags?: boolean,
): Promise<TestRun>
Parameters
- project: string
  Project ID or project name
- runId: number
- OptionalincludeDetails: boolean
- OptionalincludeTags: boolean
Returns Promise<TestRun>
Implementation of ITestResultsApi.getTestRunById
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3050

getTestRunCodeCoverage

getTestRunCodeCoverage(
    project: string,
    runId: number,
    flags: number,
): Promise<TestRunCoverage[]>
Parameters
- project: string
  Project ID or project name
- runId: number
- flags: number
Returns Promise<TestRunCoverage[]>
Implementation of ITestResultsApi.getTestRunCodeCoverage
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1217

getTestRunLogs

getTestRunLogs(
    customHeaders: any,
    project: string,
    runId: number,
    type: TestLogType,
    directoryPath?: string,
    fileNamePrefix?: string,
    fetchMetaData?: boolean,
    top?: number,
    continuationToken?: String,
): Promise<PagedList<TestLog>>
Get list of test run attachments reference
Parameters
- customHeaders: any
- project: string
  Project ID or project name
- runId: number
  Id of the test run
- type: TestLogType
  type of the attachments to get
- OptionaldirectoryPath: string
  directory path for which attachments are needed
- OptionalfileNamePrefix: string
  file name prefix to filter the list of attachment
- OptionalfetchMetaData: boolean
  Default is false, set if metadata is needed
- Optionaltop: number
  Number of attachments reference to return
- OptionalcontinuationToken: String
  Header to pass the continuationToken
Returns Promise<PagedList<TestLog>>
Implementation of ITestResultsApi.getTestRunLogs
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4567

getTestRunLogStoreAttachmentContent

getTestRunLogStoreAttachmentContent(
    project: string,
    runId: number,
    filename: string,
): Promise<ReadableStream>
Returns the attachment with the specified filename for the specified runId from the LogStore.
Parameters
- project: string
  Project ID or project name
- runId: number
  Test RunId
- filename: string
  Attachment FileName
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestRunLogStoreAttachmentContent
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4021

getTestRunLogStoreAttachments

getTestRunLogStoreAttachments(
project: string,
runId: number,
): Promise<TestLogStoreAttachment[]>
Returns a list of attachments for the specified runId from the LogStore.
Parameters
- project: string
  Project ID or project name
- runId: number
  Test RunId
Returns Promise<TestLogStoreAttachment[]>
Implementation of ITestResultsApi.getTestRunLogStoreAttachments
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4066

getTestRunLogStoreAttachmentZip

getTestRunLogStoreAttachmentZip(
    project: string,
    runId: number,
    filename: string,
): Promise<ReadableStream>
Returns the attachment with the specified filename for the specified runId from the LogStore.
Parameters
- project: string
  Project ID or project name
- runId: number
  Test RunId
- filename: string
  Attachment FileName
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestRunLogStoreAttachmentZip
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4111

getTestRunMessageLogs

getTestRunMessageLogs(
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[]>
Implementation of ITestResultsApi.getTestRunMessageLogs
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1533

getTestRuns

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 or project name
- OptionalbuildUri: string
- Optionalowner: string
- OptionaltmiRunId: string
- OptionalplanId: number
- OptionalincludeRunDetails: boolean
- Optionalautomated: boolean
- Optionalskip: number
- Optionaltop: number
Returns Promise<TestRun[]>
Implementation of ITestResultsApi.getTestRuns
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3107

getTestRunsBySessionId

getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>
Retrieves Test runs associated to a session
Parameters
- project: string
  Project ID or project name
- sessionId: number
  Id of TestResults session to obtain Test Runs for.
Returns Promise<number[]>
Implementation of ITestResultsApi.getTestRunsBySessionId
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5075

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>
Implementation of ITestResultsApi.getTestRunStatistics
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3514

getTestRunSummaryByOutcome

getTestRunSummaryByOutcome(
project: string,
runId: number,
): Promise<TestRunStatistic>
Get test run summary, used when we want to get summary of a run by outcome. Test run should be in completed state.
Parameters
- project: string
  Project ID or project name
- runId: number
  ID of the run to get.
Returns Promise<TestRunStatistic>
Implementation of ITestResultsApi.getTestRunSummaryByOutcome
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3312

getTestSession

getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>
Retrieves TestResultsSession metadata object in TCM data store
Parameters
- project: string
  Project ID or project name
- buildId: number
Returns Promise<TestResultsSession[]>
Implementation of ITestResultsApi.getTestSession
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5162

getTestSessionLayout

getTestSessionLayout(project: string, sessionId: string): Promise<any[]>
Retrieves TestResultsSession Layout object in TCM data store
Parameters
- project: string
  Project ID or project name
- sessionId: string
Returns Promise<any[]>
Implementation of ITestResultsApi.getTestSessionLayout
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5213

getTestSessionResults

getTestSessionResults(
    project: string,
    runId: number,
    detailsToInclude?: ResultDetails,
    skip?: number,
    top?: number,
    outcomes?: TestOutcome[],
    newTestsOnly?: boolean,
): Promise<TestCaseResult[]>
Parameters
- project: string
  Project ID or project name
- runId: number
- OptionaldetailsToInclude: ResultDetails
- Optionalskip: number
- Optionaltop: number
- Optionaloutcomes: TestOutcome[]
- OptionalnewTestsOnly: boolean
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.getTestSessionResults
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5446

getTestSettingsById

getTestSettingsById(
project: string,
testSettingsId: number,
): Promise<TestSettings>
Parameters
- project: string
  Project ID or project name
- testSettingsId: number
Returns Promise<TestSettings>
Implementation of ITestResultsApi.getTestSettingsById
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5638

getTestSubResultAttachmentContent

getTestSubResultAttachmentContent(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
    testSubResultId: number,
): Promise<ReadableStream>
Returns a test sub result attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
- testSubResultId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestSubResultAttachmentContent
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:595

getTestSubResultAttachments

getTestSubResultAttachments(
    project: string,
    runId: number,
    testCaseResultId: number,
    testSubResultId: number,
): Promise<TestAttachment[]>
Returns attachment references for test sub result.
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- testSubResultId: number
Returns Promise<TestAttachment[]>
Implementation of ITestResultsApi.getTestSubResultAttachments
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:646

getTestSubResultAttachmentZip

getTestSubResultAttachmentZip(
    project: string,
    runId: number,
    testCaseResultId: number,
    attachmentId: number,
    testSubResultId: number,
): Promise<ReadableStream>
Returns a test sub result attachment
Parameters
- project: string
  Project ID or project name
- runId: number
- testCaseResultId: number
- attachmentId: number
- testSubResultId: number
Returns Promise<ReadableStream>
Implementation of ITestResultsApi.getTestSubResultAttachmentZip
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:704

getTestSubResultLogs

getTestSubResultLogs(
    customHeaders: any,
    project: string,
    runId: number,
    resultId: number,
    subResultId: number,
    type: TestLogType,
    directoryPath?: string,
    fileNamePrefix?: string,
    fetchMetaData?: boolean,
    top?: number,
    continuationToken?: String,
): Promise<PagedList<TestLog>>
Get list of test subresult attachments reference
Parameters
- customHeaders: any
- project: string
  Project ID or project name
- runId: number
  Id of the test run that contains the results
- resultId: number
  Id of the test result that contains subresult
- subResultId: number
  Id of the test subresult
- type: TestLogType
  type of the attachments to get
- OptionaldirectoryPath: string
  directory path of the attachment to get
- OptionalfileNamePrefix: string
  file name prefix to filter the list of attachments
- OptionalfetchMetaData: boolean
  Default is false, set if metadata is needed
- Optionaltop: number
  Number of attachments reference to return
- OptionalcontinuationToken: String
  Header to pass the continuationToken
Returns Promise<PagedList<TestLog>>
Implementation of ITestResultsApi.getTestSubResultLogs
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4487

getTestTagsForBuild

getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>
Get all the tags in a build.
Parameters
- project: string
  Project ID or project name
- buildId: number
  Build ID
Returns Promise<TestTag[]>
Implementation of ITestResultsApi.getTestTagsForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3612

getTestTagsForRelease

getTestTagsForRelease(
    project: string,
    releaseId: number,
    releaseEnvId: number,
): Promise<TestTag[]>
Get all the tags in a release.
Parameters
- project: string
  Project ID or project name
- releaseId: number
  Release ID
- releaseEnvId: number
  Release environment ID
Returns Promise<TestTag[]>
Implementation of ITestResultsApi.getTestTagsForRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3664

getTestTagSummaryForBuild

getTestTagSummaryForBuild(
project: string,
buildId: number,
): Promise<TestTagSummary>
Get all the tags in a build.
Parameters
- project: string
  Project ID or project name
- buildId: number
  Build ID
Returns Promise<TestTagSummary>
Implementation of ITestResultsApi.getTestTagSummaryForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3766

getTestTagSummaryForRelease

getTestTagSummaryForRelease(
    project: string,
    releaseId: number,
    releaseEnvId: number,
): Promise<TestTagSummary>
Get all the tags in a release.
Parameters
- project: string
  Project ID or project name
- releaseId: number
  Release ID
- releaseEnvId: number
  Release environment ID
Returns Promise<TestTagSummary>
Implementation of ITestResultsApi.getTestTagSummaryForRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3818

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>
Implementation of ITestResultsApi.publishTestResultDocument
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1782

queryCustomFields

queryCustomFields(
project: string,
scopeFilter: CustomTestFieldScope,
): Promise<CustomTestFieldDefinition[]>
Parameters
- project: string
  Project ID or project name
- scopeFilter: CustomTestFieldScope
Returns Promise<CustomTestFieldDefinition[]>
Implementation of ITestResultsApi.queryCustomFields
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1309

queryResultTrendForBuild

queryResultTrendForBuild(
filter: TestResultTrendFilter,
project: string,
): Promise<AggregatedDataForResultTrend[]>
Parameters
- filter: TestResultTrendFilter
- project: string
  Project ID or project name
Returns Promise<AggregatedDataForResultTrend[]>
Implementation of ITestResultsApi.queryResultTrendForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2883

queryResultTrendForRelease

queryResultTrendForRelease(
filter: TestResultTrendFilter,
project: string,
): Promise<AggregatedDataForResultTrend[]>
Parameters
- filter: TestResultTrendFilter
- project: string
  Project ID or project name
Returns Promise<AggregatedDataForResultTrend[]>
Implementation of ITestResultsApi.queryResultTrendForRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2924

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>
Implementation of ITestResultsApi.queryTestHistory
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4284

queryTestMethodLinkedWorkItems

queryTestMethodLinkedWorkItems(
project: string,
testName: string,
): Promise<TestToWorkItemLinks>
Parameters
- project: string
  Project ID or project name
- testName: string
Returns Promise<TestToWorkItemLinks>
Implementation of ITestResultsApi.queryTestMethodLinkedWorkItems
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5783

queryTestResultHistory

queryTestResultHistory(
filter: ResultsFilter,
project: string,
): Promise<TestResultHistory>
Parameters
- filter: ResultsFilter
- project: string
  Project ID or project name
Returns Promise<TestResultHistory>
Implementation of ITestResultsApi.queryTestResultHistory
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1490

queryTestResultsMetaData

queryTestResultsMetaData(
    testCaseReferenceIds: string[],
    project: string,
    detailsToInclude?: ResultMetaDataDetails,
): Promise<TestResultMetaData[]>
Get list of test Result meta data details for corresponding testcasereferenceId
Parameters
- testCaseReferenceIds: 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
- OptionaldetailsToInclude: ResultMetaDataDetails
  Details to include with test results metadata. Default is None. Other values are FlakyIdentifiers.
Returns Promise<TestResultMetaData[]>
Implementation of ITestResultsApi.queryTestResultsMetaData
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1953

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>
Implementation of ITestResultsApi.queryTestResultsReportForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2612

queryTestResultsReportForPipeline

queryTestResultsReportForPipeline(
    project: string,
    pipelineId: number,
    stageName?: string,
    phaseName?: string,
    jobName?: string,
    includeFailureDetails?: boolean,
): Promise<TestResultSummary>
Get summary of test results.
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  Pipeline Id. This is same as build Id.
- OptionalstageName: string
  Name of the stage. Maximum supported length for name is 256 character.
- OptionalphaseName: string
  Name of the phase. Maximum supported length for name is 256 character.
- OptionaljobName: string
  Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
- OptionalincludeFailureDetails: boolean
  If true returns failure insights
Returns Promise<TestResultSummary>
Implementation of ITestResultsApi.queryTestResultsReportForPipeline
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2673

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>
Implementation of ITestResultsApi.queryTestResultsReportForRelease
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2734

queryTestResultsSummaryForReleases

queryTestResultsSummaryForReleases(
releases: ReleaseReference[],
project: string,
): Promise<TestResultSummary[]>
Parameters
- releases: ReleaseReference[]
- project: string
  Project ID or project name
Returns Promise<TestResultSummary[]>
Implementation of ITestResultsApi.queryTestResultsSummaryForReleases
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2794

queryTestResultWorkItems

queryTestResultWorkItems(
    project: string,
    workItemCategory: string,
    automatedTestName?: string,
    testCaseId?: number,
    maxCompleteDate?: Date,
    days?: number,
    workItemCount?: number,
): Promise<WorkItemReference[]>
Query Test Result WorkItems based on filter
Parameters
- project: string
  Project ID or project name
- workItemCategory: string
  can take values Microsoft.BugCategory or all(for getting all workitems)
- OptionalautomatedTestName: string
- OptionaltestCaseId: number
- OptionalmaxCompleteDate: Date
- Optionaldays: number
- OptionalworkItemCount: number
Returns Promise<WorkItemReference[]>
Implementation of ITestResultsApi.queryTestResultWorkItems
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5884

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.
- 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.
- OptionalbuildDefIds: number[]
  Build Definition Ids of the Runs to be queried, comma separated list of valid ids.
- 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.
- OptionalreleaseDefIds: number[]
  Release Definition Ids of the Runs to be queried, comma separated list of valid ids.
- OptionalreleaseEnvIds: number[]
  Release Environment Ids of the Runs to be queried, comma separated list of valid ids.
- OptionalreleaseEnvDefIds: number[]
  Release Environment Definition Ids of the Runs to be queried, comma separated list of valid ids.
- 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>>
Implementation of ITestResultsApi.queryTestRuns
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3184

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[]>
Implementation of ITestResultsApi.queryTestSummaryByRequirement
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2836

testLogStoreEndpointDetailsForBuild

testLogStoreEndpointDetailsForBuild(
    project: string,
    buildId: number,
    testLogStoreOperationType: TestLogStoreOperationType,
): Promise<TestLogStoreEndpointDetails>
Create and Get sas uri of the build container
Parameters
- project: string
  Project ID or project name
- buildId: number
  Id of the build to get
- testLogStoreOperationType: TestLogStoreOperationType
  Type of operation to perform using sas uri
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.testLogStoreEndpointDetailsForBuild
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4698

testLogStoreEndpointDetailsForResult

testLogStoreEndpointDetailsForResult(
    project: string,
    runId: number,
    resultId: number,
    subResultId: number,
    filePath: string,
    type: TestLogType,
): Promise<TestLogStoreEndpointDetails>
Create empty file for a result and Get Sas uri for the file
Parameters
- project: string
  Project ID or project name
- runId: number
  Id of the test run that contains the result
- resultId: number
  Id of the test results that contains sub result
- subResultId: number
  Id of the test sub result whose file sas uri is needed
- filePath: string
  file path inside the sub result for which sas uri is needed
- type: TestLogType
  Type of the file for download
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.testLogStoreEndpointDetailsForResult
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:4890

testLogStoreEndpointDetailsForRun

testLogStoreEndpointDetailsForRun(
    project: string,
    runId: number,
    testLogStoreOperationType: TestLogStoreOperationType,
    filePath?: string,
    type?: TestLogType,
): Promise<TestLogStoreEndpointDetails>
Create empty file for a run and Get Sas uri for the file
Parameters
- project: string
  Project ID or project name
- runId: number
  Id of the run to get endpoint details
- testLogStoreOperationType: TestLogStoreOperationType
  Type of operation to perform using sas uri
- OptionalfilePath: string
  file path to create an empty file
- Optionaltype: TestLogType
  Default is GeneralAttachment, type of empty file to be created
Returns Promise<TestLogStoreEndpointDetails>
Implementation of ITestResultsApi.testLogStoreEndpointDetailsForRun
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5018

testResultsGroupDetails

testResultsGroupDetails(
    project: string,
    pipelineId: number,
    stageName?: string,
    phaseName?: string,
    jobName?: string,
    shouldIncludeFailedAndAbortedResults?: boolean,
    queryGroupSummaryForInProgress?: boolean,
): Promise<TestResultsDetails>
Get all the available groups details and for these groups get failed and aborted results.
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  Pipeline Id. This is same as build Id.
- OptionalstageName: string
  Name of the stage. Maximum supported length for name is 256 character.
- OptionalphaseName: string
  Name of the phase. Maximum supported length for name is 256 character.
- OptionaljobName: string
  Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
- OptionalshouldIncludeFailedAndAbortedResults: boolean
  If true, it will return Ids of failed and aborted results for each test group
- OptionalqueryGroupSummaryForInProgress: boolean
  If true, it will calculate summary for InProgress runs as well.
Returns Promise<TestResultsDetails>
Implementation of ITestResultsApi.testResultsGroupDetails
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2550

updateCodeCoverageSummary

updateCodeCoverageSummary(
    project: string,
    buildId: number,
    coverageData?: CodeCoverageData,
): Promise<void>
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Request: Json of code coverage summary
Parameters
- project: string
  Project ID or project name
- buildId: number
- OptionalcoverageData: CodeCoverageData
Returns Promise<void>
Implementation of ITestResultsApi.updateCodeCoverageSummary
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:1166

updatePipelinesTestSettings

updatePipelinesTestSettings(
testResultsUpdateSettings: TestResultsUpdateSettings,
project: string,
): Promise<TestResultsSettings>
Update project settings of test results
Parameters
- testResultsUpdateSettings: TestResultsUpdateSettings
- project: string
  Project ID or project name
Returns Promise<TestResultsSettings>
Implementation of ITestResultsApi.updatePipelinesTestSettings
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3404

updateTestResults

updateTestResults(
    results: TestCaseResult[],
    project: string,
    runId: number,
): Promise<TestCaseResult[]>
Parameters
- results: TestCaseResult[]
- project: string
  Project ID or project name
- runId: number
Returns Promise<TestCaseResult[]>
Implementation of ITestResultsApi.updateTestResults
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2302

updateTestResultsMetaData

updateTestResultsMetaData(
    testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput,
    project: string,
    testCaseReferenceId: number,
): Promise<TestResultMetaData>
Update properties of test result meta data
Parameters
- testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput
  TestResultMetaData update input TestResultMetaDataUpdateInput
- project: string
  Project ID or project name
- testCaseReferenceId: number
  TestCaseReference Id of Test Result to be updated.
Returns Promise<TestResultMetaData>
Implementation of ITestResultsApi.updateTestResultsMetaData
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:2003

updateTestResultsToTestRunSession

updateTestResultsToTestRunSession(
    results: TestCaseResult[],
    project: string,
    runId: number,
): Promise<number[]>
Creates TestResultsMRX objects in TCM data store for existing test results
Parameters
- results: TestCaseResult[]
  Results object with only test results MRX properties and existing testResultId
- project: string
  Project ID or project name
- runId: number
  RunId of test run
Returns Promise<number[]>
Implementation of ITestResultsApi.updateTestResultsToTestRunSession
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:5505

updateTestRun

updateTestRun(
    runUpdateModel: RunUpdateModel,
    project: string,
    runId: number,
): Promise<TestRun>
Parameters
- runUpdateModel: RunUpdateModel
- project: string
  Project ID or project name
- runId: number
Returns Promise<TestRun>
Implementation of ITestResultsApi.updateTestRun
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3267

updateTestRunTags

updateTestRunTags(
    testTagsUpdateModel: TestTagsUpdateModel,
    project: string,
    runId: number,
): Promise<TestTag[]>
Update tags of a run, Tags can be Added and Deleted
Parameters
- testTagsUpdateModel: TestTagsUpdateModel
  TestTagsUpdateModel
- project: string
  Project ID or project name
- runId: number
  RunId of the run
Returns Promise<TestTag[]>
Implementation of ITestResultsApi.updateTestRunTags
- Defined in repos/azure-devops-node-api/api/TestResultsApi.ts:3721

Class TestResultsApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TestResultsApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Static ReadonlyRESOURCE_AREA_ID

Methods

addCustomFields

Parameters

Returns Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun

Parameters

Returns Promise<TestCaseResult[]>

addTestResultsToTestRunSession

Parameters

Returns Promise<TestCaseResult[]>

addWorkItemToTestLinks

Parameters

Returns Promise<WorkItemToTestLinks>

createAcceptHeader

Parameters

Returns string

createBuildAttachmentInLogStore

Parameters

Returns Promise<void>

createEnvironment

Parameters

Returns Promise<void>

createFailureType

Parameters

Returns Promise<TestResultFailureType>

createNotification

Parameters

Returns Promise<number[]>

createRequestOptions

Parameters

Returns IRequestOptions

createTestIterationResultAttachment

Parameters

Returns Promise<TestAttachmentReference>

createTestResultAttachment

Parameters

Returns Promise<TestAttachmentReference>

createTestRun

Parameters

Returns Promise<TestRun>

createTestRunAttachment

Parameters

Returns Promise<TestAttachmentReference>

createTestRunLogStoreAttachment

Parameters

Returns Promise<TestLogStoreAttachmentReference>

createTestSession

Parameters

Returns Promise<number>

createTestSettings

Parameters

Returns Promise<number>

createTestSubResultAttachment

Parameters

Returns Promise<TestAttachmentReference>

deleteFailureType

Parameters

Returns Promise<void>

deleteTestMethodToWorkItemLink

Parameters

Returns Promise<boolean>

deleteTestResultAttachment

`Static` `Readonly`RESOURCE_AREA_ID