Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TestSuitesApi

Hierarchy

  • TestSuitesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

addTestCasesToSuite

  • Add test cases to suite.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
      • testCaseIds: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<SuiteTestCase>>

createTestSuite

  • createTestSuite(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestSuite>

  • Create test suite.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestSuite>

deleteTestSuite

  • deleteTestSuite(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Delete test suite.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getSuitesByTestCaseId

  • getSuitesByTestCaseId(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TestSuite>>

  • Find the list of all test suites in which a given test case is present. This is helpful if you need to find out which test suites are using a test case, when you need to make changes to a test case.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • testCaseId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TestSuite>>

getTestCaseById

  • getTestCaseById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<SuiteTestCase>

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

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
      • testCaseIds: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<SuiteTestCase>

getTestCases

  • Get all test cases in a suite.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<SuiteTestCase>>

getTestSuiteById

  • getTestSuiteById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestSuite>

  • Get test suite by suite id.

    Parameters

    • params: object
      • apiVersion: string
      • Optional expand?: string
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestSuite>

getTestSuitesForPlan

  • getTestSuitesForPlan(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TestSuite>>

  • Get test suites for plan.

    Parameters

    • params: object
      • apiVersion: string
      • Optional asTreeView?: boolean
      • Optional continuationToken?: string
      • Optional expand?: string
      • organization: string
      • planId: number
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TestSuite>>

removeTestCasesFromSuiteUrl

  • removeTestCasesFromSuiteUrl(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

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

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
      • testCaseIds: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

updateSuiteTestCases

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

    Parameters

    • params: object
      • apiVersion: string
      • body: SuiteTestCaseUpdateModel
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
      • testCaseIds: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<SuiteTestCase>>

updateTestSuite

  • updateTestSuite(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestSuite>

  • Update test suite.

    Parameters

    • params: object
      • apiVersion: string
      • body: TestSuiteUpdateParams
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestSuite>

Generated using TypeDoc