interface ITestPlanApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addTestCasesToSuite(
        suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[],
        project: string,
        planId: number,
        suiteId: number,
    ): Promise<TestCase[]>;
    cloneTestCase(
        cloneRequestBody: CloneTestCaseParams,
        project: string,
    ): Promise<CloneTestCaseOperationInformation>;
    cloneTestPlan(
        cloneRequestBody: CloneTestPlanParams,
        project: string,
        deepClone?: boolean,
    ): Promise<CloneTestPlanOperationInformation>;
    cloneTestSuite(
        cloneRequestBody: CloneTestSuiteParams,
        project: string,
        deepClone?: boolean,
    ): Promise<CloneTestSuiteOperationInformation>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createBulkTestSuites(
        testSuiteCreateParams: TestSuiteCreateParams[],
        project: string,
        planId: number,
        parentSuiteId: number,
    ): Promise<TestSuite[]>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTestConfiguration(
        testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters,
        project: string,
    ): Promise<TestConfiguration>;
    createTestPlan(
        testPlanCreateParams: TestPlanCreateParams,
        project: string,
    ): Promise<TestPlan>;
    createTestSuite(
        testSuiteCreateParams: TestSuiteCreateParams,
        project: string,
        planId: number,
    ): Promise<TestSuite>;
    createTestVariable(
        testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters,
        project: string,
    ): Promise<TestVariable>;
    deleteTestCase(project: string, testCaseId: number): Promise<void>;
    deleteTestConfguration(
        project: string,
        testConfiguartionId: number,
    ): Promise<void>;
    deleteTestPlan(project: string, planId: number): Promise<void>;
    deleteTestSuite(
        project: string,
        planId: number,
        suiteId: number,
    ): Promise<void>;
    deleteTestVariable(project: string, testVariableId: number): Promise<void>;
    exportTestCases(
        exportTestCaseRequestBody: ExportTestCaseParams,
        project: string,
    ): Promise<ReadableStream>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getCloneInformation(
        project: string,
        cloneOperationId: number,
    ): Promise<CloneTestPlanOperationInformation>;
    getPoints(
        project: string,
        planId: number,
        suiteId: number,
        pointId: string,
        returnIdentityRef?: boolean,
        includePointDetails?: boolean,
    ): Promise<TestPoint[]>;
    getPointsList(
        project: string,
        planId: number,
        suiteId: number,
        testPointIds?: string,
        testCaseId?: string,
        continuationToken?: string,
        returnIdentityRef?: boolean,
        includePointDetails?: boolean,
        isRecursive?: boolean,
    ): Promise<PagedList<TestPoint>>;
    getSuiteCloneInformation(
        project: string,
        cloneOperationId: number,
    ): Promise<CloneTestSuiteOperationInformation>;
    getSuiteEntries(
        project: string,
        suiteId: number,
        suiteEntryType?: SuiteEntryTypes,
    ): Promise<SuiteEntry[]>;
    getSuitesByTestCaseId(testCaseId: number): Promise<TestSuite[]>;
    getTestCase(
        project: string,
        planId: number,
        suiteId: number,
        testCaseId: string,
        witFields?: string,
        returnIdentityRef?: boolean,
    ): Promise<TestCase[]>;
    getTestCaseCloneInformation(
        project: string,
        cloneOperationId: number,
    ): Promise<CloneTestCaseOperationInformation>;
    getTestCaseList(
        project: string,
        planId: number,
        suiteId: number,
        testIds?: string,
        configurationIds?: string,
        witFields?: string,
        continuationToken?: string,
        returnIdentityRef?: boolean,
        expand?: boolean,
        excludeFlags?: ExcludeFlags,
        isRecursive?: boolean,
    ): Promise<PagedList<TestCase>>;
    getTestConfigurationById(
        project: string,
        testConfigurationId: number,
    ): Promise<TestConfiguration>;
    getTestConfigurations(
        project: string,
        continuationToken?: string,
    ): Promise<PagedList<TestConfiguration>>;
    getTestEntityCountByPlanId(
        project: string,
        planId: number,
        states?: string,
        outcome?: UserFriendlyTestOutcome,
        configurations?: string,
        testers?: string,
        assignedTo?: string,
        entity?: TestEntityTypes,
    ): Promise<TestEntityCount[]>;
    getTestPlanById(project: string, planId: number): Promise<TestPlan>;
    getTestPlans(
        project: string,
        owner?: string,
        continuationToken?: string,
        includePlanDetails?: boolean,
        filterActivePlans?: boolean,
    ): Promise<PagedList<TestPlan>>;
    getTestSuiteById(
        project: string,
        planId: number,
        suiteId: number,
        expand?: SuiteExpand,
    ): Promise<TestSuite>;
    getTestSuitesForPlan(
        project: string,
        planId: number,
        expand?: SuiteExpand,
        continuationToken?: string,
        asTreeView?: boolean,
    ): Promise<PagedList<TestSuite>>;
    getTestVariableById(
        project: string,
        testVariableId: number,
    ): Promise<TestVariable>;
    getTestVariables(
        project: string,
        continuationToken?: string,
    ): Promise<PagedList<TestVariable>>;
    removeTestCasesFromSuite(
        project: string,
        planId: number,
        suiteId: number,
        testCaseIds: string,
    ): Promise<void>;
    removeTestCasesListFromSuite(
        project: string,
        planId: number,
        suiteId: number,
        testIds: string,
    ): Promise<void>;
    reorderSuiteEntries(
        suiteEntries: SuiteEntryUpdateParams[],
        project: string,
        suiteId: number,
    ): Promise<SuiteEntry[]>;
    updateSuiteTestCases(
        suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[],
        project: string,
        planId: number,
        suiteId: number,
    ): Promise<TestCase[]>;
    updateTestConfiguration(
        testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters,
        project: string,
        testConfiguartionId: number,
    ): Promise<TestConfiguration>;
    updateTestPlan(
        testPlanUpdateParams: TestPlanUpdateParams,
        project: string,
        planId: number,
    ): Promise<TestPlan>;
    updateTestPoints(
        testPointUpdateParams: TestPointUpdateParams[],
        project: string,
        planId: number,
        suiteId: number,
        includePointDetails?: boolean,
        returnIdentityRef?: boolean,
    ): Promise<TestPoint[]>;
    updateTestSuite(
        testSuiteUpdateParams: TestSuiteUpdateParams,
        project: string,
        planId: number,
        suiteId: number,
    ): Promise<TestSuite>;
    updateTestVariable(
        testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters,
        project: string,
        testVariableId: number,
    ): Promise<TestVariable>;
}

Hierarchy (View Summary)

Implemented by

Properties

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

Methods

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • pointId: string
    • OptionalreturnIdentityRef: boolean
    • OptionalincludePointDetails: boolean

    Returns Promise<TestPoint[]>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • OptionaltestPointIds: string
    • OptionaltestCaseId: string
    • OptionalcontinuationToken: string
    • OptionalreturnIdentityRef: boolean
    • OptionalincludePointDetails: boolean
    • OptionalisRecursive: boolean

    Returns Promise<PagedList<TestPoint>>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • testCaseId: string
    • OptionalwitFields: string
    • OptionalreturnIdentityRef: boolean

    Returns Promise<TestCase[]>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • OptionaltestIds: string
    • OptionalconfigurationIds: string
    • OptionalwitFields: string
    • OptionalcontinuationToken: string
    • OptionalreturnIdentityRef: boolean
    • Optionalexpand: boolean
    • OptionalexcludeFlags: ExcludeFlags
    • OptionalisRecursive: boolean

    Returns Promise<PagedList<TestCase>>

  • Parameters

    • project: string
    • Optionalowner: string
    • OptionalcontinuationToken: string
    • OptionalincludePlanDetails: boolean
    • OptionalfilterActivePlans: boolean

    Returns Promise<PagedList<TestPlan>>

  • Parameters

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

    Returns Promise<void>

  • Parameters

    • project: string
    • planId: number
    • suiteId: number
    • testIds: string

    Returns Promise<void>