interface ITestApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addCustomFields(
        newFields: CustomTestFieldDefinition[],
        project: string,
    ): Promise<CustomTestFieldDefinition[]>;
    addTestCasesToSuite(
        project: string,
        planId: number,
        suiteId: number,
        testCaseIds: string,
    ): Promise<SuiteTestCase[]>;
    addTestResultsToTestRun(
        results: TestCaseResult[],
        project: string,
        runId: number,
    ): Promise<TestCaseResult[]>;
    addWorkItemToTestLinks(
        workItemToTestLinks: WorkItemToTestLinks,
        project: string,
    ): Promise<WorkItemToTestLinks>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTestIterationResultAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
        testCaseResultId: number,
        iterationId: number,
        actionPath?: string,
    ): Promise<TestAttachmentReference>;
    createTestResultAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<TestAttachmentReference>;
    createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>;
    createTestRunAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
    ): Promise<TestAttachmentReference>;
    createTestSession(
        testSession: TestSession,
        teamContext: TeamContext,
    ): Promise<TestSession>;
    createTestSettings(
        testSettings: TestSettings,
        project: string,
    ): Promise<number>;
    createTestSubResultAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
        testCaseResultId: number,
        testSubResultId: number,
    ): Promise<TestAttachmentReference>;
    deleteSharedParameter(
        project: string,
        sharedParameterId: number,
    ): Promise<void>;
    deleteSharedStep(project: string, sharedStepId: number): Promise<void>;
    deleteTestCase(project: string, testCaseId: number): Promise<void>;
    deleteTestMethodToWorkItemLink(
        project: string,
        testName: string,
        workItemId: number,
    ): Promise<boolean>;
    deleteTestRun(project: string, runId: number): Promise<void>;
    deleteTestSettings(project: string, testSettingsId: number): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getBugsLinkedToTestResult(
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<WorkItemReference[]>;
    getBuildCodeCoverage(
        project: string,
        buildId: number,
        flags: number,
    ): Promise<BuildCoverage[]>;
    getCodeCoverageSummary(
        project: string,
        buildId: number,
        deltaBuildId?: number,
    ): Promise<CodeCoverageSummary>;
    getLinkedWorkItemsByQuery(
        workItemQuery: LinkedWorkItemsQuery,
        project: string,
    ): Promise<LinkedWorkItemsQueryResult[]>;
    getPoint(
        project: string,
        planId: number,
        suiteId: number,
        pointIds: number,
        witFields?: string,
    ): Promise<TestPoint>;
    getPoints(
        project: string,
        planId: number,
        suiteId: number,
        witFields?: string,
        configurationId?: string,
        testCaseId?: string,
        testPointIds?: string,
        includePointDetails?: boolean,
        skip?: number,
        top?: number,
    ): Promise<TestPoint[]>;
    getPointsByQuery(
        query: TestPointsQuery,
        project: string,
        skip?: number,
        top?: number,
    ): Promise<TestPointsQuery>;
    getResultGroupsByBuild(
        project: string,
        buildId: number,
        publishContext: string,
        fields?: string[],
        continuationToken?: string,
    ): Promise<PagedList<FieldDetailsForTestResults>>;
    getResultGroupsByRelease(
        project: string,
        releaseId: number,
        publishContext: string,
        releaseEnvId?: number,
        fields?: string[],
        continuationToken?: string,
    ): Promise<PagedList<FieldDetailsForTestResults>>;
    getResultRetentionSettings(
        project: string,
    ): Promise<ResultRetentionSettings>;
    getTestCaseById(
        project: string,
        planId: number,
        suiteId: number,
        testCaseIds: number,
    ): Promise<SuiteTestCase>;
    getTestCases(
        project: string,
        planId: number,
        suiteId: number,
    ): Promise<SuiteTestCase[]>;
    getTestIteration(
        project: string,
        runId: number,
        testCaseResultId: number,
        iterationId: number,
        includeActionResults?: boolean,
    ): Promise<TestIterationDetailsModel>;
    getTestIterations(
        project: string,
        runId: number,
        testCaseResultId: number,
        includeActionResults?: boolean,
    ): Promise<TestIterationDetailsModel[]>;
    getTestResultAttachmentContent(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestResultAttachments(
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<TestAttachment[]>;
    getTestResultAttachmentZip(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestResultById(
        project: string,
        runId: number,
        testCaseResultId: number,
        detailsToInclude?: ResultDetails,
    ): Promise<TestCaseResult>;
    getTestResultDetailsForBuild(
        project: string,
        buildId: number,
        publishContext?: string,
        groupBy?: string,
        filter?: string,
        orderby?: string,
        shouldIncludeResults?: boolean,
        queryRunSummaryForInProgress?: boolean,
    ): Promise<TestResultsDetails>;
    getTestResultDetailsForRelease(
        project: string,
        releaseId: number,
        releaseEnvId: number,
        publishContext?: string,
        groupBy?: string,
        filter?: string,
        orderby?: string,
        shouldIncludeResults?: boolean,
        queryRunSummaryForInProgress?: boolean,
    ): Promise<TestResultsDetails>;
    getTestResults(
        project: string,
        runId: number,
        detailsToInclude?: ResultDetails,
        skip?: number,
        top?: number,
        outcomes?: TestOutcome[],
    ): Promise<TestCaseResult[]>;
    getTestResultsByBuild(
        project: string,
        buildId: number,
        publishContext?: string,
        outcomes?: TestOutcome[],
        top?: number,
        continuationToken?: string,
    ): Promise<PagedList<ShallowTestCaseResult>>;
    getTestResultsByQuery(
        query: TestResultsQuery,
        project: string,
    ): Promise<TestResultsQuery>;
    getTestResultsByRelease(
        project: string,
        releaseId: number,
        releaseEnvid?: number,
        publishContext?: string,
        outcomes?: TestOutcome[],
        top?: number,
        continuationToken?: string,
    ): Promise<PagedList<ShallowTestCaseResult>>;
    getTestRunAttachmentContent(
        project: string,
        runId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestRunAttachments(
        project: string,
        runId: number,
    ): Promise<TestAttachment[]>;
    getTestRunAttachmentZip(
        project: string,
        runId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestRunById(
        project: string,
        runId: number,
        includeDetails?: boolean,
    ): Promise<TestRun>;
    getTestRunCodeCoverage(
        project: string,
        runId: number,
        flags: number,
    ): Promise<TestRunCoverage[]>;
    getTestRunLogs(
        project: string,
        runId: number,
    ): Promise<TestMessageLogDetails[]>;
    getTestRuns(
        project: string,
        buildUri?: string,
        owner?: string,
        tmiRunId?: string,
        planId?: number,
        includeRunDetails?: boolean,
        automated?: boolean,
        skip?: number,
        top?: number,
    ): Promise<TestRun[]>;
    getTestRunStatistics(
        project: string,
        runId: number,
    ): Promise<TestRunStatistic>;
    getTestSessions(
        teamContext: TeamContext,
        period?: number,
        allSessions?: boolean,
        includeAllProperties?: boolean,
        source?: TestSessionSource,
        includeOnlyCompletedSessions?: boolean,
    ): Promise<TestSession[]>;
    getTestSettingsById(
        project: string,
        testSettingsId: number,
    ): Promise<TestSettings>;
    getTestSubResultAttachmentContent(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
        testSubResultId: number,
    ): Promise<ReadableStream>;
    getTestSubResultAttachments(
        project: string,
        runId: number,
        testCaseResultId: number,
        testSubResultId: number,
    ): Promise<TestAttachment[]>;
    getTestSubResultAttachmentZip(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
        testSubResultId: number,
    ): Promise<ReadableStream>;
    publishTestResultDocument(
        document: TestResultDocument,
        project: string,
        runId: number,
    ): Promise<TestResultDocument>;
    queryCustomFields(
        project: string,
        scopeFilter: CustomTestFieldScope,
    ): Promise<CustomTestFieldDefinition[]>;
    queryResultTrendForBuild(
        filter: TestResultTrendFilter,
        project: string,
    ): Promise<AggregatedDataForResultTrend[]>;
    queryResultTrendForRelease(
        filter: TestResultTrendFilter,
        project: string,
    ): Promise<AggregatedDataForResultTrend[]>;
    queryTestHistory(
        filter: TestHistoryQuery,
        project: string,
    ): Promise<TestHistoryQuery>;
    queryTestMethodLinkedWorkItems(
        project: string,
        testName: string,
    ): Promise<TestToWorkItemLinks>;
    queryTestResultHistory(
        filter: ResultsFilter,
        project: string,
    ): Promise<TestResultHistory>;
    queryTestResultsMetaData(
        testReferenceIds: string[],
        project: string,
    ): Promise<TestResultMetaData[]>;
    queryTestResultsReportForBuild(
        project: string,
        buildId: number,
        publishContext?: string,
        includeFailureDetails?: boolean,
        buildToCompare?: BuildReference,
    ): Promise<TestResultSummary>;
    queryTestResultsReportForRelease(
        project: string,
        releaseId: number,
        releaseEnvId: number,
        publishContext?: string,
        includeFailureDetails?: boolean,
        releaseToCompare?: ReleaseReference,
    ): Promise<TestResultSummary>;
    queryTestResultsSummaryForReleases(
        releases: ReleaseReference[],
        project: string,
    ): Promise<TestResultSummary[]>;
    queryTestResultWorkItems(
        project: string,
        workItemCategory: string,
        automatedTestName?: string,
        testCaseId?: number,
        maxCompleteDate?: Date,
        days?: number,
        workItemCount?: number,
    ): Promise<WorkItemReference[]>;
    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>>;
    queryTestSummaryByRequirement(
        resultsContext: TestResultsContext,
        project: string,
        workItemIds?: number[],
    ): Promise<TestSummaryForWorkItem[]>;
    removeTestCasesFromSuiteUrl(
        project: string,
        planId: number,
        suiteId: number,
        testCaseIds: string,
    ): Promise<void>;
    updateCodeCoverageSummary(
        coverageData: CodeCoverageData,
        project: string,
        buildId: number,
    ): Promise<void>;
    updateResultRetentionSettings(
        retentionSettings: ResultRetentionSettings,
        project: string,
    ): Promise<ResultRetentionSettings>;
    updateSuiteTestCases(
        suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel,
        project: string,
        planId: number,
        suiteId: number,
        testCaseIds: string,
    ): Promise<SuiteTestCase[]>;
    updateTestPoints(
        pointUpdateModel: PointUpdateModel,
        project: string,
        planId: number,
        suiteId: number,
        pointIds: string,
    ): Promise<TestPoint[]>;
    updateTestResults(
        results: TestCaseResult[],
        project: string,
        runId: number,
    ): Promise<TestCaseResult[]>;
    updateTestRun(
        runUpdateModel: RunUpdateModel,
        project: string,
        runId: number,
    ): Promise<TestRun>;
    updateTestSession(
        testSession: TestSession,
        teamContext: TeamContext,
    ): Promise<TestSession>;
}

Hierarchy (View Summary)

Implemented by

Properties

Methods

addCustomFields addTestCasesToSuite addTestResultsToTestRun addWorkItemToTestLinks createAcceptHeader createRequestOptions createTestIterationResultAttachment createTestResultAttachment createTestRun createTestRunAttachment createTestSession createTestSettings createTestSubResultAttachment deleteSharedParameter deleteSharedStep deleteTestCase deleteTestMethodToWorkItemLink deleteTestRun deleteTestSettings formatResponse getBugsLinkedToTestResult getBuildCodeCoverage getCodeCoverageSummary getLinkedWorkItemsByQuery getPoint getPoints getPointsByQuery getResultGroupsByBuild getResultGroupsByRelease getResultRetentionSettings getTestCaseById getTestCases getTestIteration getTestIterations getTestResultAttachmentContent getTestResultAttachments getTestResultAttachmentZip getTestResultById getTestResultDetailsForBuild getTestResultDetailsForRelease getTestResults getTestResultsByBuild getTestResultsByQuery getTestResultsByRelease getTestRunAttachmentContent getTestRunAttachments getTestRunAttachmentZip getTestRunById getTestRunCodeCoverage getTestRunLogs getTestRuns getTestRunStatistics getTestSessions getTestSettingsById getTestSubResultAttachmentContent getTestSubResultAttachments getTestSubResultAttachmentZip publishTestResultDocument queryCustomFields queryResultTrendForBuild queryResultTrendForRelease queryTestHistory queryTestMethodLinkedWorkItems queryTestResultHistory queryTestResultsMetaData queryTestResultsReportForBuild queryTestResultsReportForRelease queryTestResultsSummaryForReleases queryTestResultWorkItems queryTestRuns queryTestSummaryByRequirement removeTestCasesFromSuiteUrl updateCodeCoverageSummary updateResultRetentionSettings updateSuiteTestCases updateTestPoints updateTestResults updateTestRun updateTestSession

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • project: string
    • testName: string
    • workItemId: number

    Returns Promise<boolean>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • pointIds: number
    • OptionalwitFields: string

    Returns Promise<TestPoint>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • OptionalwitFields: string
    • OptionalconfigurationId: string
    • OptionaltestCaseId: string
    • OptionaltestPointIds: string
    • OptionalincludePointDetails: boolean
    • Optionalskip: number
    • Optionaltop: number

    Returns Promise<TestPoint[]>

  • Parameters

    • project: string
    • runId: number
    • testCaseResultId: number
    • attachmentId: number

    Returns Promise<ReadableStream>

  • Parameters

    • project: string
    • runId: number
    • testCaseResultId: number
    • attachmentId: number

    Returns Promise<ReadableStream>

  • Parameters

    • project: string
    • buildId: number
    • OptionalpublishContext: string
    • OptionalgroupBy: string
    • Optionalfilter: string
    • Optionalorderby: string
    • OptionalshouldIncludeResults: boolean
    • OptionalqueryRunSummaryForInProgress: boolean

    Returns Promise<TestResultsDetails>

  • Parameters

    • project: string
    • releaseId: number
    • releaseEnvId: number
    • OptionalpublishContext: string
    • OptionalgroupBy: string
    • Optionalfilter: string
    • Optionalorderby: string
    • OptionalshouldIncludeResults: boolean
    • OptionalqueryRunSummaryForInProgress: boolean

    Returns Promise<TestResultsDetails>

  • Parameters

    • project: string
    • runId: number
    • attachmentId: number

    Returns Promise<ReadableStream>

  • Parameters

    • project: string
    • runId: number
    • attachmentId: number

    Returns Promise<ReadableStream>

  • Parameters

    • project: string
    • OptionalbuildUri: string
    • Optionalowner: string
    • OptionaltmiRunId: string
    • OptionalplanId: number
    • OptionalincludeRunDetails: boolean
    • Optionalautomated: boolean
    • Optionalskip: number
    • Optionaltop: number

    Returns Promise<TestRun[]>

  • Parameters

    • project: string
    • runId: number
    • testCaseResultId: number
    • attachmentId: number
    • testSubResultId: number

    Returns Promise<ReadableStream>

  • Parameters

    • project: string
    • runId: number
    • testCaseResultId: number
    • attachmentId: number
    • testSubResultId: number

    Returns Promise<ReadableStream>

  • Parameters

    • project: string
    • workItemCategory: string
    • OptionalautomatedTestName: string
    • OptionaltestCaseId: number
    • OptionalmaxCompleteDate: Date
    • Optionaldays: number
    • OptionalworkItemCount: number

    Returns Promise<WorkItemReference[]>

  • Parameters

    • project: string
    • minLastUpdatedDate: Date
    • maxLastUpdatedDate: Date
    • Optionalstate: TestRunState
    • OptionalplanIds: number[]
    • OptionalisAutomated: boolean
    • OptionalpublishContext: TestRunPublishContext
    • OptionalbuildIds: number[]
    • OptionalbuildDefIds: number[]
    • OptionalbranchName: string
    • OptionalreleaseIds: number[]
    • OptionalreleaseDefIds: number[]
    • OptionalreleaseEnvIds: number[]
    • OptionalreleaseEnvDefIds: number[]
    • OptionalrunTitle: string
    • Optionaltop: number
    • OptionalcontinuationToken: string

    Returns Promise<PagedList<TestRun>>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • testCaseIds: string

    Returns Promise<void>