Class TestPlanApi

Hierarchy (View Summary)

ClientApiBase
- TestPlanApi

Implements

ITestPlanApi

Index

Constructors

constructor

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

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

addTestCasesToSuite

addTestCasesToSuite(
    suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[],
    project: string,
    planId: number,
    suiteId: number,
): Promise<TestCase[]>
Add test cases to a suite with specified configurations
Parameters
- suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]
  SuiteTestCaseCreateUpdateParameters object.
- project: string
  Project ID or project name
- planId: number
  ID of the test plan to which test cases are to be added.
- suiteId: number
  ID of the test suite to which test cases are to be added.
Returns Promise<TestCase[]>
Implementation of ITestPlanApi.addTestCasesToSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1062

cloneTestCase

cloneTestCase(
cloneRequestBody: CloneTestCaseParams,
project: string,
): Promise<CloneTestCaseOperationInformation>
Parameters
- cloneRequestBody: CloneTestCaseParams
- project: string
  Project ID or project name
Returns Promise<CloneTestCaseOperationInformation>
Implementation of ITestPlanApi.cloneTestCase
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1405

cloneTestPlan

cloneTestPlan(
    cloneRequestBody: CloneTestPlanParams,
    project: string,
    deepClone?: boolean,
): Promise<CloneTestPlanOperationInformation>
Clone test plan
Parameters
- cloneRequestBody: CloneTestPlanParams
  Plan Clone Request Body detail TestPlanCloneRequest
- project: string
  Project ID or project name
- OptionaldeepClone: boolean
  Clones all the associated test cases as well
Returns Promise<CloneTestPlanOperationInformation>
Implementation of ITestPlanApi.cloneTestPlan
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1572

cloneTestSuite

cloneTestSuite(
    cloneRequestBody: CloneTestSuiteParams,
    project: string,
    deepClone?: boolean,
): Promise<CloneTestSuiteOperationInformation>
Clone test suite
Parameters
- cloneRequestBody: CloneTestSuiteParams
  Suite Clone Request Body detail TestSuiteCloneRequest
- project: string
  Project ID or project name
- OptionaldeepClone: boolean
  Clones all the associated test cases as well
Returns Promise<CloneTestSuiteOperationInformation>
Implementation of ITestPlanApi.cloneTestSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1857

createAcceptHeader

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

createBulkTestSuites

createBulkTestSuites(
    testSuiteCreateParams: TestSuiteCreateParams[],
    project: string,
    planId: number,
    parentSuiteId: number,
): Promise<TestSuite[]>
Create bulk requirement based test suites.
Parameters
- testSuiteCreateParams: TestSuiteCreateParams[]
  Parameters for suite creation
- project: string
  Project ID or project name
- planId: number
  ID of the test plan where requirement based suites need to be created.
- parentSuiteId: number
  ID of the parent suite under which requirement based suites will be created
Returns Promise<TestSuite[]>
Implementation of ITestPlanApi.createBulkTestSuites
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:712

createRequestOptions

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

createTestConfiguration

createTestConfiguration(
testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters,
project: string,
): Promise<TestConfiguration>
Create a test configuration.
Parameters
- testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters
  TestConfigurationCreateUpdateParameters
- project: string
  Project ID or project name
Returns Promise<TestConfiguration>
Implementation of ITestPlanApi.createTestConfiguration
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:76

createTestPlan

createTestPlan(
testPlanCreateParams: TestPlanCreateParams,
project: string,
): Promise<TestPlan>
Create a test plan.
Parameters
- testPlanCreateParams: TestPlanCreateParams
  A testPlanCreateParams object.TestPlanCreateParams
- project: string
  Project ID or project name
Returns Promise<TestPlan>
Implementation of ITestPlanApi.createTestPlan
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:379

createTestSuite

createTestSuite(
    testSuiteCreateParams: TestSuiteCreateParams,
    project: string,
    planId: number,
): Promise<TestSuite>
Create test suite.
Parameters
- testSuiteCreateParams: TestSuiteCreateParams
  Parameters for suite creation
- project: string
  Project ID or project name
- planId: number
  ID of the test plan that contains the suites.
Returns Promise<TestSuite>
Implementation of ITestPlanApi.createTestSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:760

createTestVariable

createTestVariable(
testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters,
project: string,
): Promise<TestVariable>
Create a test variable.
Parameters
- testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters
  TestVariableCreateUpdateParameters
- project: string
  Project ID or project name
Returns Promise<TestVariable>
Implementation of ITestPlanApi.createTestVariable
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1950

deleteTestCase

deleteTestCase(project: string, testCaseId: number): Promise<void>
Delete a test case.
Parameters
- project: string
  Project ID or project name
- testCaseId: number
  Id of test case to be deleted.
Returns Promise<void>
Implementation of ITestPlanApi.deleteTestCase
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1527

deleteTestConfguration

deleteTestConfguration(
project: string,
testConfiguartionId: number,
): Promise<void>
Delete a test configuration by its ID.
Parameters
- project: string
  Project ID or project name
- testConfiguartionId: number
  ID of the test configuration to delete.
Returns Promise<void>
Implementation of ITestPlanApi.deleteTestConfguration
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:119

deleteTestPlan

deleteTestPlan(project: string, planId: number): Promise<void>
Delete a test plan.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan to be deleted.
Returns Promise<void>
Implementation of ITestPlanApi.deleteTestPlan
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:422

deleteTestSuite

deleteTestSuite(project: string, planId: number, suiteId: number): Promise<void>
Delete test suite.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan that contains the suite.
- suiteId: number
  ID of the test suite to delete.
Returns Promise<void>
Implementation of ITestPlanApi.deleteTestSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:806

deleteTestVariable

deleteTestVariable(project: string, testVariableId: number): Promise<void>
Delete a test variable by its ID.
Parameters
- project: string
  Project ID or project name
- testVariableId: number
  ID of the test variable to delete.
Returns Promise<void>
Implementation of ITestPlanApi.deleteTestVariable
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1993

exportTestCases

exportTestCases(
exportTestCaseRequestBody: ExportTestCaseParams,
project: string,
): Promise<ReadableStream>
Exports a set of test cases from a suite to a file. Currently supported formats: xlsx
Parameters
- exportTestCaseRequestBody: ExportTestCaseParams
  A ExportTestCaseParams object.ExportTestCaseParams
- project: string
  Project ID or project name
Returns Promise<ReadableStream>
Implementation of ITestPlanApi.exportTestCases
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1492

formatResponse

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

getCloneInformation

getCloneInformation(
project: string,
cloneOperationId: number,
): Promise<CloneTestPlanOperationInformation>
Get clone information.
Parameters
- project: string
  Project ID or project name
- cloneOperationId: number
  Operation ID returned when we queue a clone operation
Returns Promise<CloneTestPlanOperationInformation>
Implementation of ITestPlanApi.getCloneInformation
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1621

getPoints

getPoints(
    project: string,
    planId: number,
    suiteId: number,
    pointId: string,
    returnIdentityRef?: boolean,
    includePointDetails?: boolean,
): Promise<TestPoint[]>
Get a particular Test Point from a suite.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan for which test points are requested.
- suiteId: number
  ID of the test suite for which test points are requested.
- pointId: string
  ID of test point to be fetched.
- OptionalreturnIdentityRef: boolean
  If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
- OptionalincludePointDetails: boolean
  If set to false, will get a smaller payload containing only basic details about the test point object
Returns Promise<TestPoint[]>
Implementation of ITestPlanApi.getPoints
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1669

getPointsList

getPointsList(
    project: string,
    planId: number,
    suiteId: number,
    testPointIds?: string,
    testCaseId?: string,
    continuationToken?: string,
    returnIdentityRef?: boolean,
    includePointDetails?: boolean,
    isRecursive?: boolean,
): Promise<PagedList<TestPoint>>
Get all the points inside a suite based on some filters
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan for which test points are requested.
- suiteId: number
  ID of the test suite for which test points are requested
- OptionaltestPointIds: string
  ID of test points to fetch.
- OptionaltestCaseId: string
  Get Test Points for specific test case Ids.
- OptionalcontinuationToken: string
  If the list of test point returned is not complete, a continuation token to query next batch of test points is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test points.
- OptionalreturnIdentityRef: boolean
  If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
- OptionalincludePointDetails: boolean
  If set to false, will get a smaller payload containing only basic details about the test point object
- OptionalisRecursive: boolean
  If set to true, will also fetch test points belonging to child suites recursively.
Returns Promise<PagedList<TestPoint>>
Implementation of ITestPlanApi.getPointsList
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1735

getSuiteCloneInformation

getSuiteCloneInformation(
project: string,
cloneOperationId: number,
): Promise<CloneTestSuiteOperationInformation>
Get clone information.
Parameters
- project: string
  Project ID or project name
- cloneOperationId: number
  Operation ID returned when we queue a clone operation
Returns Promise<CloneTestSuiteOperationInformation>
Implementation of ITestPlanApi.getSuiteCloneInformation
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1906

getSuiteEntries

getSuiteEntries(
    project: string,
    suiteId: number,
    suiteEntryType?: SuiteEntryTypes,
): Promise<SuiteEntry[]>
Get a list of test suite entries in the test suite.
Parameters
- project: string
  Project ID or project name
- suiteId: number
  Id of the parent suite.
- OptionalsuiteEntryType: SuiteEntryTypes
Returns Promise<SuiteEntry[]>
Implementation of ITestPlanApi.getSuiteEntries
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:614

getSuitesByTestCaseId

getSuitesByTestCaseId(testCaseId: number): Promise<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
- testCaseId: number
  ID of the test case for which suites need to be fetched.
Returns Promise<TestSuite[]>
Implementation of ITestPlanApi.getSuitesByTestCaseId
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1011

getTestCase

getTestCase(
    project: string,
    planId: number,
    suiteId: number,
    testCaseId: string,
    witFields?: string,
    returnIdentityRef?: boolean,
): Promise<TestCase[]>
Get a particular Test Case from a Suite.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan for which test cases are requested.
- suiteId: number
  ID of the test suite for which test cases are requested.
- testCaseId: string
  Test Case Id to be fetched.
- OptionalwitFields: string
  Get the list of witFields.
- OptionalreturnIdentityRef: boolean
  If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
Returns Promise<TestCase[]>
Implementation of ITestPlanApi.getTestCase
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1113

getTestCaseCloneInformation

getTestCaseCloneInformation(
project: string,
cloneOperationId: number,
): Promise<CloneTestCaseOperationInformation>
Get clone information.
Parameters
- project: string
  Project ID or project name
- cloneOperationId: number
  Operation ID returned when we queue a clone operation
Returns Promise<CloneTestCaseOperationInformation>
Implementation of ITestPlanApi.getTestCaseCloneInformation
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1448

getTestCaseList

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>>
Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional parameter. If configuration Ids is null, it return all the test cases
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan for which test cases are requested.
- suiteId: number
  ID of the test suite for which test cases are requested.
- OptionaltestIds: string
  Test Case Ids to be fetched.
- OptionalconfigurationIds: string
  Fetch Test Cases which contains all the configuration Ids specified.
- OptionalwitFields: string
  Get the list of witFields.
- OptionalcontinuationToken: string
  If the list of test cases returned is not complete, a continuation token to query next batch of test cases is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test cases.
- OptionalreturnIdentityRef: boolean
  If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
- Optionalexpand: boolean
  If set to false, will get a smaller payload containing only basic details about the suite test case object
- OptionalexcludeFlags: ExcludeFlags
  Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).
- OptionalisRecursive: boolean
Returns Promise<PagedList<TestCase>>
Implementation of ITestPlanApi.getTestCaseList
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1178

getTestConfigurationById

getTestConfigurationById(
project: string,
testConfigurationId: number,
): Promise<TestConfiguration>
Get a test configuration
Parameters
- project: string
  Project ID or project name
- testConfigurationId: number
  ID of the test configuration to get.
Returns Promise<TestConfiguration>
Implementation of ITestPlanApi.getTestConfigurationById
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:170

getTestConfigurations

getTestConfigurations(
project: string,
continuationToken?: string,
): Promise<PagedList<TestConfiguration>>
Get a list of test configurations.
Parameters
- project: string
  Project ID or project name
- OptionalcontinuationToken: string
  If the list of configurations returned is not complete, a continuation token to query next batch of configurations is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test configurations.
Returns Promise<PagedList<TestConfiguration>>
Implementation of ITestPlanApi.getTestConfigurations
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:214

getTestEntityCountByPlanId

getTestEntityCountByPlanId(
    project: string,
    planId: number,
    states?: string,
    outcome?: UserFriendlyTestOutcome,
    configurations?: string,
    testers?: string,
    assignedTo?: string,
    entity?: TestEntityTypes,
): Promise<TestEntityCount[]>
Parameters
- project: string
  Project ID or project name
- planId: number
- Optionalstates: string
- Optionaloutcome: UserFriendlyTestOutcome
- Optionalconfigurations: string
- Optionaltesters: string
- OptionalassignedTo: string
- Optionalentity: TestEntityTypes
Returns Promise<TestEntityCount[]>
Implementation of ITestPlanApi.getTestEntityCountByPlanId
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:319

getTestPlanById

getTestPlanById(project: string, planId: number): Promise<TestPlan>
Get a test plan by Id.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan to get.
Returns Promise<TestPlan>
Implementation of ITestPlanApi.getTestPlanById
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:466

getTestPlans

getTestPlans(
    project: string,
    owner?: string,
    continuationToken?: string,
    includePlanDetails?: boolean,
    filterActivePlans?: boolean,
): Promise<PagedList<TestPlan>>
Get a list of test plans
Parameters
- project: string
  Project ID or project name
- Optionalowner: string
  Filter for test plan by owner ID or name
- OptionalcontinuationToken: string
  If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.
- OptionalincludePlanDetails: boolean
  Get all properties of the test plan
- OptionalfilterActivePlans: boolean
  Get just the active plans
Returns Promise<PagedList<TestPlan>>
Implementation of ITestPlanApi.getTestPlans
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:513

getTestSuiteById

getTestSuiteById(
    project: string,
    planId: number,
    suiteId: number,
    expand?: SuiteExpand,
): Promise<TestSuite>
Get test suite by suite id.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan that contains the suites.
- suiteId: number
  ID of the suite to get.
- Optionalexpand: SuiteExpand
  Include the children suites and testers details
Returns Promise<TestSuite>
Implementation of ITestPlanApi.getTestSuiteById
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:854

getTestSuitesForPlan

getTestSuitesForPlan(
    project: string,
    planId: number,
    expand?: SuiteExpand,
    continuationToken?: string,
    asTreeView?: boolean,
): Promise<PagedList<TestSuite>>
Get test suites for plan.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan for which suites are requested.
- Optionalexpand: SuiteExpand
  Include the children suites and testers details.
- OptionalcontinuationToken: string
  If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
- OptionalasTreeView: boolean
  If the suites returned should be in a tree structure.
Returns Promise<PagedList<TestSuite>>
Implementation of ITestPlanApi.getTestSuitesForPlan
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:909

getTestVariableById

getTestVariableById(
project: string,
testVariableId: number,
): Promise<TestVariable>
Get a test variable by its ID.
Parameters
- project: string
  Project ID or project name
- testVariableId: number
  ID of the test variable to get.
Returns Promise<TestVariable>
Implementation of ITestPlanApi.getTestVariableById
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:2037

getTestVariables

getTestVariables(
project: string,
continuationToken?: string,
): Promise<PagedList<TestVariable>>
Get a list of test variables.
Parameters
- project: string
  Project ID or project name
- OptionalcontinuationToken: string
  If the list of variables returned is not complete, a continuation token to query next batch of variables is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test variables.
Returns Promise<PagedList<TestVariable>>
Implementation of ITestPlanApi.getTestVariables
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:2081

removeTestCasesFromSuite

removeTestCasesFromSuite(
    project: string,
    planId: number,
    suiteId: number,
    testCaseIds: string,
): Promise<void>
Removes test cases from a suite based on the list of test case Ids provided.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan from which test cases are to be removed.
- suiteId: number
  ID of the test suite from which test cases are to be removed.
- testCaseIds: string
  Test Case Ids to be removed.
Returns Promise<void>
Implementation of ITestPlanApi.removeTestCasesFromSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1246

removeTestCasesListFromSuite

removeTestCasesListFromSuite(
    project: string,
    planId: number,
    suiteId: number,
    testIds: string,
): Promise<void>
Removes test cases from a suite based on the list of test case Ids provided. This API can be used to remove a larger number of test cases.
Parameters
- project: string
  Project ID or project name
- planId: number
  ID of the test plan from which test cases are to be removed.
- suiteId: number
  ID of the test suite from which test cases are to be removed.
- testIds: string
  Comma separated string of Test Case Ids to be removed.
Returns Promise<void>
Implementation of ITestPlanApi.removeTestCasesListFromSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1303

reorderSuiteEntries

reorderSuiteEntries(
    suiteEntries: SuiteEntryUpdateParams[],
    project: string,
    suiteId: number,
): Promise<SuiteEntry[]>
Reorder test suite entries in the test suite.
Parameters
- suiteEntries: SuiteEntryUpdateParams[]
  List of SuiteEntry to reorder.
- project: string
  Project ID or project name
- suiteId: number
  Id of the parent test suite.
Returns Promise<SuiteEntry[]>
Implementation of ITestPlanApi.reorderSuiteEntries
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:665

updateSuiteTestCases

updateSuiteTestCases(
    suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[],
    project: string,
    planId: number,
    suiteId: number,
): Promise<TestCase[]>
Update the configurations for test cases
Parameters
- suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]
  A SuiteTestCaseCreateUpdateParameters object.
- project: string
  Project ID or project name
- planId: number
  ID of the test plan to which test cases are to be updated.
- suiteId: number
  ID of the test suite to which test cases are to be updated.
Returns Promise<TestCase[]>
Implementation of ITestPlanApi.updateSuiteTestCases
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1360

updateTestConfiguration

updateTestConfiguration(
    testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters,
    project: string,
    testConfiguartionId: number,
): Promise<TestConfiguration>
Update a test configuration by its ID.
Parameters
- testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters
  TestConfigurationCreateUpdateParameters
- project: string
  Project ID or project name
- testConfiguartionId: number
  ID of the test configuration to update.
Returns Promise<TestConfiguration>
Implementation of ITestPlanApi.updateTestConfiguration
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:263

updateTestPlan

updateTestPlan(
    testPlanUpdateParams: TestPlanUpdateParams,
    project: string,
    planId: number,
): Promise<TestPlan>
Update a test plan.
Parameters
- testPlanUpdateParams: TestPlanUpdateParams
  A testPlanUpdateParams object.TestPlanUpdateParams
- project: string
  Project ID or project name
- planId: number
  ID of the test plan to be updated.
Returns Promise<TestPlan>
Implementation of ITestPlanApi.updateTestPlan
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:568

updateTestPoints

updateTestPoints(
    testPointUpdateParams: TestPointUpdateParams[],
    project: string,
    planId: number,
    suiteId: number,
    includePointDetails?: boolean,
    returnIdentityRef?: boolean,
): Promise<TestPoint[]>
Update Test Points. This is used to Reset test point to active, update the outcome of a test point or update the tester of a test point
Parameters
- testPointUpdateParams: TestPointUpdateParams[]
  A TestPointUpdateParams Object.
- project: string
  Project ID or project name
- planId: number
  ID of the test plan for which test points are requested.
- suiteId: number
  ID of the test suite for which test points are requested.
- OptionalincludePointDetails: boolean
  If set to false, will get a smaller payload containing only basic details about the test point object
- OptionalreturnIdentityRef: boolean
  If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
Returns Promise<TestPoint[]>
Implementation of ITestPlanApi.updateTestPoints
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:1801

updateTestSuite

updateTestSuite(
    testSuiteUpdateParams: TestSuiteUpdateParams,
    project: string,
    planId: number,
    suiteId: number,
): Promise<TestSuite>
Update test suite.
Parameters
- testSuiteUpdateParams: TestSuiteUpdateParams
  Parameters for suite updation
- project: string
  Project ID or project name
- planId: number
  ID of the test plan that contains the suites.
- suiteId: number
  ID of the parent suite.
Returns Promise<TestSuite>
Implementation of ITestPlanApi.updateTestSuite
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:965

updateTestVariable

updateTestVariable(
    testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters,
    project: string,
    testVariableId: number,
): Promise<TestVariable>
Update a test variable by its ID.
Parameters
- testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters
  TestVariableCreateUpdateParameters
- project: string
  Project ID or project name
- testVariableId: number
  ID of the test variable to update.
Returns Promise<TestVariable>
Implementation of ITestPlanApi.updateTestVariable
- Defined in repos/azure-devops-node-api/api/TestPlanApi.ts:2130

Class TestPlanApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TestPlanApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

addTestCasesToSuite

Parameters

Returns Promise<TestCase[]>

cloneTestCase

Parameters

Returns Promise<CloneTestCaseOperationInformation>

cloneTestPlan

Parameters

Returns Promise<CloneTestPlanOperationInformation>

cloneTestSuite

Parameters

Returns Promise<CloneTestSuiteOperationInformation>

createAcceptHeader

Parameters

Returns string

createBulkTestSuites

Parameters

Returns Promise<TestSuite[]>

createRequestOptions

Parameters

Returns IRequestOptions

createTestConfiguration

Parameters

Returns Promise<TestConfiguration>

createTestPlan

Parameters

Returns Promise<TestPlan>

createTestSuite

Parameters

Returns Promise<TestSuite>

createTestVariable

Parameters

Returns Promise<TestVariable>

deleteTestCase

Parameters

Returns Promise<void>

deleteTestConfguration

Parameters

Returns Promise<void>

deleteTestPlan

Parameters

Returns Promise<void>

deleteTestSuite

Parameters

Returns Promise<void>

deleteTestVariable

Parameters

Returns Promise<void>

exportTestCases

Parameters

Returns Promise<ReadableStream>

formatResponse

Parameters

Returns any

getCloneInformation

Parameters

Returns Promise<CloneTestPlanOperationInformation>

getPoints

Parameters

Returns Promise<TestPoint[]>

getPointsList

Parameters