TestPlanRestClient class

Ссылка

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends: RestClientBase

Конструкторы

TestPlanRestClient(IVssRestClientOptions)

Методы

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Добавление тестовых случаев в набор с указанными конфигурациями
cloneTestCase(CloneTestCaseParams, string)
cloneTestPlan(CloneTestPlanParams, string, boolean)	Клонирование плана тестирования
cloneTestSuite(CloneTestSuiteParams, string, boolean)	Клонирование набора тестов
createBulkTestSuites(TestSuiteCreateParams[], string, number, number)	Create наборы тестов на основе массовых требований.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Create конфигурации теста.
createTestPlan(TestPlanCreateParams, string)	Create план тестирования.
createTestSuite(TestSuiteCreateParams, string, number)	Create набор тестов.
createTestVariable(TestVariableCreateUpdateParameters, string)	Create тестовой переменной.
deleteTestCase(string, number)	Удаление тестового случая.
deleteTestConfguration(string, number)	Удаление тестовой конфигурации по ее идентификатору.
deleteTestPlan(string, number)	Удаление плана тестирования.
deleteTestSuite(string, number, number)	Удалите набор тестов.
deleteTestVariable(string, number)	Удаление тестовой переменной по ее идентификатору.
exportTestCases(ExportTestCaseParams, string)	Экспортирует набор тестовых случаев из набора в файл. Поддерживаемые в настоящее время форматы: xlsx
getCloneInformation(string, number)	Получение сведений о клоне.
getPoints(string, number, number, string, boolean, boolean)	Получение конкретной точки тестирования из набора.
getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)	Получение всех точек в наборе на основе некоторых фильтров
getSuiteCloneInformation(string, number)	Получение сведений о клоне.
getSuiteEntries(string, number, SuiteEntryTypes)	Получение списка записей набора тестов в наборе тестов.
getSuitesByTestCaseId(number)	Найдите список всех наборов тестов, в которых присутствует данный тестовый случай. Это полезно, если вам нужно узнать, какие наборы тестов используют тестовый случай, когда необходимо внести изменения в тестовый случай.
getTestCase(string, number, number, string, string, boolean)	Получите конкретный тестовый случай из набора.
getTestCaseCloneInformation(string, number)	Получение сведений о клоне.
getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)	Получение списка тестовых случаев возвращает те тестовые случаи, которые имеют все идентификаторы конфигурации, как указано в необязательном параметре. Если идентификаторы конфигурации равно NULL, возвращаются все тестовые случаи.
getTestConfigurationById(string, number)	Получение тестовой конфигурации
getTestConfigurations(string, string)	Получение списка конфигураций тестирования.
getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)
getTestPlanById(string, number)	Получите план тестирования по идентификатору.
getTestPlans(string, string, string, boolean, boolean)	Получение списка планов тестирования
getTestSuiteById(string, number, number, SuiteExpand)	Получение набора тестов по идентификатору набора.
getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Получите наборы тестов для плана.
getTestVariableById(string, number)	Получение тестовой переменной по ее идентификатору.
getTestVariables(string, string)	Получение списка тестовых переменных.
removeTestCasesFromSuite(string, number, number, string)	Удаляет тестовые случаи из набора на основе списка предоставленных идентификаторов тестовых случаев.
removeTestCasesListFromSuite(string, number, number, string)	Удаляет тестовые случаи из набора на основе списка предоставленных идентификаторов тестовых случаев. Этот API можно использовать для удаления большего количества тестовых случаев.
reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)	Переупорядочение записей набора тестов в наборе тестов.
restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)	Восстановление удаленного плана тестирования
restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)	Восстановление удаленного набора тестов
updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)	Обновление конфигураций для тестовых случаев
updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)	Обновите тестовую конфигурацию по ее идентификатору.
updateTestPlan(TestPlanUpdateParams, string, number)	Обновление плана тестирования.
updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)	Обновление тестовых точек. Используется для сброса активной тестовой точки, обновления результатов точки тестирования или обновления тестировщика точки тестирования.
updateTestSuite(TestSuiteUpdateParams, string, number, number)	Обновление набора тестов.
updateTestVariable(TestVariableCreateUpdateParameters, string, number)	Обновите тестовую переменную по ее идентификатору.

Сведения о конструкторе

TestPlanRestClient(IVssRestClientOptions)

new TestPlanRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

Сведения о методе

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Добавление тестовых случаев в набор с указанными конфигурациями

function addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Параметры

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Объект SuiteTestCaseCreateUpdateParameters.

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, в который необходимо добавить тестовые случаи.

suiteId: number

Идентификатор набора тестов, в который добавляются тестовые случаи.

Возвращаемое значение

Promise<TestCase[]>

cloneTestCase(CloneTestCaseParams, string)

function cloneTestCase(cloneRequestBody: CloneTestCaseParams, project: string): Promise<CloneTestCaseOperationInformation>

Параметры

cloneRequestBody: CloneTestCaseParams

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<CloneTestCaseOperationInformation>

cloneTestPlan(CloneTestPlanParams, string, boolean)

Клонирование плана тестирования

function cloneTestPlan(cloneRequestBody: CloneTestPlanParams, project: string, deepClone?: boolean): Promise<CloneTestPlanOperationInformation>

Параметры

cloneRequestBody: CloneTestPlanParams

Plan Clone Request Body detail TestPlanCloneRequest

project: string

Идентификатор или имя проекта

deepClone: boolean

Клонирует все связанные тестовые случаи.

Возвращаемое значение

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Клонирование набора тестов

function cloneTestSuite(cloneRequestBody: CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<CloneTestSuiteOperationInformation>

Параметры

cloneRequestBody: CloneTestSuiteParams

Сведения о тексте запроса клона Suite TestSuiteCloneRequest

project: string

Идентификатор или имя проекта

deepClone: boolean

Клонирует все связанные тестовые случаи.

Возвращаемое значение

Promise<CloneTestSuiteOperationInformation>

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Create наборы тестов на основе массовых требований.

function createBulkTestSuites(testSuiteCreateParams: TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestSuite[]>

Параметры

testSuiteCreateParams: TestSuiteCreateParams[]

Параметры для создания набора

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, в котором необходимо создать наборы на основе требований.

parentSuiteId: number

Идентификатор родительского набора, в котором будут создаваться наборы на основе требований

Возвращаемое значение

Promise<TestSuite[]>

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Create конфигурации теста.

function createTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string): Promise<TestConfiguration>

Параметры

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

Create план тестирования.

function createTestPlan(testPlanCreateParams: TestPlanCreateParams, project: string): Promise<TestPlan>

Параметры

testPlanCreateParams: TestPlanCreateParams

Объект testPlanCreateParams. TestPlanCreateParams

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<TestPlan>

createTestSuite(TestSuiteCreateParams, string, number)

Create набор тестов.

function createTestSuite(testSuiteCreateParams: TestSuiteCreateParams, project: string, planId: number): Promise<TestSuite>

Параметры

testSuiteCreateParams: TestSuiteCreateParams

Параметры для создания набора

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, содержащего наборы.

Возвращаемое значение

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

Create тестовой переменной.

function createTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string): Promise<TestVariable>

Параметры

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<TestVariable>

deleteTestCase(string, number)

Удаление тестового случая.

function deleteTestCase(project: string, testCaseId: number): Promise<void>

Параметры

project: string

Идентификатор или имя проекта

testCaseId: number

Идентификатор удаляемого тестового случая.

Возвращаемое значение

Promise<void>

deleteTestConfguration(string, number)

Удаление тестовой конфигурации по ее идентификатору.

function deleteTestConfguration(project: string, testConfiguartionId: number): Promise<void>

Параметры

project: string

Идентификатор или имя проекта

testConfiguartionId: number

Идентификатор удаляемой конфигурации теста.

Возвращаемое значение

Promise<void>

deleteTestPlan(string, number)

Удаление плана тестирования.

function deleteTestPlan(project: string, planId: number): Promise<void>

Параметры

project: string

Идентификатор или имя проекта

planId: number

Идентификатор удаляемого плана тестирования.

Возвращаемое значение

Promise<void>

deleteTestSuite(string, number, number)

Удалите набор тестов.

function deleteTestSuite(project: string, planId: number, suiteId: number): Promise<void>

Параметры

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, содержащего набор.

suiteId: number

Идентификатор удаляемого набора тестов.

Возвращаемое значение

Promise<void>

deleteTestVariable(string, number)

Удаление тестовой переменной по ее идентификатору.

function deleteTestVariable(project: string, testVariableId: number): Promise<void>

Параметры

project: string

Идентификатор или имя проекта

testVariableId: number

Идентификатор удаляемой тестовой переменной.

Возвращаемое значение

Promise<void>

exportTestCases(ExportTestCaseParams, string)

Экспортирует набор тестовых случаев из набора в файл. Поддерживаемые в настоящее время форматы: xlsx

function exportTestCases(exportTestCaseRequestBody: ExportTestCaseParams, project: string): Promise<ArrayBuffer>

Параметры

exportTestCaseRequestBody: ExportTestCaseParams

Объект ExportTestCaseParams. ExportTestCaseParams

project: string

Идентификатор или имя проекта

Возвращаемое значение

Promise<ArrayBuffer>

getCloneInformation(string, number)

Получение сведений о клоне.

function getCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestPlanOperationInformation>

Параметры

project: string

Идентификатор или имя проекта

cloneOperationId: number

Идентификатор операции, возвращаемый при постановке операции клонирования в очередь

Возвращаемое значение

Promise<CloneTestPlanOperationInformation>

getPoints(string, number, number, string, boolean, boolean)

Получение конкретной точки тестирования из набора.

function getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPoint[]>

Параметры

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, для которого запрашиваются тестовые точки.

suiteId: number

Идентификатор набора тестов, для которого запрашиваются тестовые точки.

pointId: string

Идентификатор извлекаемой точки тестирования.

returnIdentityRef: boolean

Если задано значение true, возвращает поле AssignedTo в TestCaseReference как объект IdentityRef.

includePointDetails: boolean

Если задано значение false, получает меньшие полезные данные, содержащие только основные сведения об объекте точки тестирования.

Возвращаемое значение

Promise<TestPoint[]>

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Получение всех точек в наборе на основе некоторых фильтров

function getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<PagedList<TestPoint>>

Параметры

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, для которого запрашиваются тестовые точки.

suiteId: number

Идентификатор набора тестов, для которого запрашиваются тестовые точки

testPointIds: string

Идентификатор тестовых точек для получения.

testCaseId: string

Получение точек тестирования для определенных идентификаторов тестовых случаев.

continuationToken: string

Если список возвращаемых точек тестирования не завершен, маркер продолжения для запроса следующего пакета тестовых точек включается в заголовок ответа как "x-ms-continuationtoken". Опустите этот параметр, чтобы получить первый пакет тестовых точек.

returnIdentityRef: boolean

Если задано значение true, возвращает поле AssignedTo в TestCaseReference как объект IdentityRef.

includePointDetails: boolean

isRecursive: boolean

Если задано значение true, также рекурсивно извлекает тестовые точки, принадлежащие дочерним наборам.

Возвращаемое значение

Promise<PagedList<TestPoint>>

getSuiteCloneInformation(string, number)

Получение сведений о клоне.

function getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestSuiteOperationInformation>

Параметры

project: string

Идентификатор или имя проекта

cloneOperationId: number

Идентификатор операции, возвращаемый при постановке операции клонирования в очередь

Возвращаемое значение

Promise<CloneTestSuiteOperationInformation>

getSuiteEntries(string, number, SuiteEntryTypes)

Получение списка записей набора тестов в наборе тестов.

function getSuiteEntries(project: string, suiteId: number, suiteEntryType?: SuiteEntryTypes): Promise<SuiteEntry[]>

Параметры

project: string

Идентификатор или имя проекта

suiteId: number

Идентификатор родительского набора.

suiteEntryType: SuiteEntryTypes

Возвращаемое значение

Promise<SuiteEntry[]>

getSuitesByTestCaseId(number)

Найдите список всех наборов тестов, в которых присутствует данный тестовый случай. Это полезно, если вам нужно узнать, какие наборы тестов используют тестовый случай, когда необходимо внести изменения в тестовый случай.

function getSuitesByTestCaseId(testCaseId: number): Promise<TestSuite[]>

Параметры

testCaseId: number

Идентификатор тестового случая, для которого необходимо получить наборы.

Возвращаемое значение

Promise<TestSuite[]>

getTestCase(string, number, number, string, string, boolean)

Получите конкретный тестовый случай из набора.

function getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestCase[]>

Параметры

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, для которого запрашиваются тестовые случаи.

suiteId: number

Идентификатор набора тестов, для которого запрашиваются тестовые случаи.

testCaseId: string

Идентификатор тестового случая для получения.

witFields: string

Получение списка witFields.

returnIdentityRef: boolean

Если задано значение true, возвращает все поля идентификаторов, такие как AssignedTo, ActivatedBy и т. д., в качестве объектов IdentityRef. Если задано значение false, эти поля возвращаются в виде уникальных имен в формате строки. По умолчанию используется значение false.

Возвращаемое значение

Promise<TestCase[]>

getTestCaseCloneInformation(string, number)

Получение сведений о клоне.

function getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<CloneTestCaseOperationInformation>

Параметры

project: string

Идентификатор или имя проекта

cloneOperationId: number

Идентификатор операции, возвращаемый при постановке операции клонирования в очередь

Возвращаемое значение

Promise<CloneTestCaseOperationInformation>

getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)

Получение списка тестовых случаев возвращает те тестовые случаи, которые имеют все идентификаторы конфигурации, как указано в необязательном параметре. Если идентификаторы конфигурации равно NULL, возвращаются все тестовые случаи.

function 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>>

Параметры

project: string

Идентификатор или имя проекта

planId: number

Идентификатор плана тестирования, для которого запрашиваются тестовые случаи.

suiteId: number

Идентификатор набора тестов, для которого запрашиваются тестовые случаи.

testIds: string

Идентификаторы тестовых случаев для получения.

configurationIds: string

Выборка тестовых случаев, содержащих все указанные идентификаторы конфигурации.

witFields: string

Получение списка witFields.

continuationToken: string

Если список возвращаемых тестовых случаев не завершен, маркер продолжения для запроса следующего пакета тестовых случаев включается в заголовок ответа как "x-ms-continuationtoken". Опустите этот параметр, чтобы получить первый пакет тестовых случаев.

returnIdentityRef: boolean

Если задано значение true, возвращает все поля идентификаторов, такие как AssignedTo, ActivatedBy и т. д., в виде объектов IdentityRef. Если задано значение false, эти поля возвращаются как уникальные имена в строковом формате. По умолчанию используется значение false.

expand: boolean

Если задано значение false, будет получать небольшие полезные данные, содержащие только основные сведения об объекте тестового случая набора.

excludeFlags: ExcludeFlags

Флаг для исключения различных значений из полезных данных. Например, чтобы удалить назначения точек, передайте исключение = 1. Чтобы удалить дополнительные сведения (ссылки, план тестирования, набор тестов), выполните исключение = 2. Чтобы удалить как дополнительную информацию, так и назначения точек, необходимо исключить = 3 (1 + 2).

isRecursive: boolean

Возвращаемое значение

Promise<PagedList<TestCase>>

getTestConfigurationById(string, number)

Получение тестовой конфигурации

function getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestConfiguration>

Параметры

project: string

Идентификатор проекта или имя проекта

testConfigurationId: number

Идентификатор получаемой конфигурации теста.

Возвращаемое значение

Promise<TestConfiguration>

getTestConfigurations(string, string)

Получение списка конфигураций тестирования.

function getTestConfigurations(project: string, continuationToken?: string): Promise<PagedList<TestConfiguration>>

Параметры

project: string

Идентификатор проекта или имя проекта

continuationToken: string

Если список возвращаемых конфигураций не завершен, маркер продолжения для запроса следующего пакета конфигураций включается в заголовок ответа как "x-ms-continuationtoken". Опустите этот параметр, чтобы получить первый пакет конфигураций теста.

Возвращаемое значение

Promise<PagedList<TestConfiguration>>

getTestEntityCountByPlanId(string, number, string, UserFriendlyTestOutcome, string, string, string, TestEntityTypes)

function getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestEntityTypes): Promise<TestEntityCount[]>

Параметры

project: string

Идентификатор проекта или имя проекта

planId: number

states: string

outcome: UserFriendlyTestOutcome

configurations: string

testers: string

assignedTo: string

entity: TestEntityTypes

Возвращаемое значение

Promise<TestEntityCount[]>

getTestPlanById(string, number)

Получите план тестирования по идентификатору.

function getTestPlanById(project: string, planId: number): Promise<TestPlan>

Параметры

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор получаемого плана тестирования.

Возвращаемое значение

Promise<TestPlan>

getTestPlans(string, string, string, boolean, boolean)

Получение списка планов тестирования

function getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<PagedList<TestPlan>>

Параметры

project: string

Идентификатор проекта или имя проекта

owner: string

Фильтрация для плана тестирования по идентификатору или имени владельца

continuationToken: string

Если список возвращаемых планов не завершен, маркер продолжения для запроса следующего пакета планов включается в заголовок ответа как "x-ms-continuationtoken". Опустите этот параметр, чтобы получить первый пакет планов тестирования.

includePlanDetails: boolean

Получение всех свойств плана тестирования

filterActivePlans: boolean

Получение только активных планов

Возвращаемое значение

Promise<PagedList<TestPlan>>

getTestSuiteById(string, number, number, SuiteExpand)

Получение набора тестов по идентификатору набора.

function getTestSuiteById(project: string, planId: number, suiteId: number, expand?: SuiteExpand): Promise<TestSuite>

Параметры

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, содержащего наборы.

suiteId: number

Идентификатор набора, который нужно получить.

expand: SuiteExpand

Добавление сведений о детских наборах и тестировщиках

Возвращаемое значение

Promise<TestSuite>

getTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Получите наборы тестов для плана.

function getTestSuitesForPlan(project: string, planId: number, expand?: SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<PagedList<TestSuite>>

Параметры

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, для которого запрашиваются наборы.

expand: SuiteExpand

Включите дочерние наборы и сведения тестировщиков.

continuationToken: string

Если список возвращаемых наборов не завершен, маркер продолжения для запроса следующего пакета наборов включается в заголовок ответа как "x-ms-continuationtoken". Опустите этот параметр, чтобы получить первый пакет наборов тестов.

asTreeView: boolean

Если возвращаемые наборы должны находиться в древовидной структуре.

Возвращаемое значение

Promise<PagedList<TestSuite>>

getTestVariableById(string, number)

Получение тестовой переменной по ее идентификатору.

function getTestVariableById(project: string, testVariableId: number): Promise<TestVariable>

Параметры

project: string

Идентификатор проекта или имя проекта

testVariableId: number

Идентификатор получаемой тестовой переменной.

Возвращаемое значение

Promise<TestVariable>

getTestVariables(string, string)

Получение списка тестовых переменных.

function getTestVariables(project: string, continuationToken?: string): Promise<PagedList<TestVariable>>

Параметры

project: string

Идентификатор проекта или имя проекта

continuationToken: string

Если список возвращаемых переменных не завершен, маркер продолжения для запроса следующего пакета переменных включается в заголовок ответа как "x-ms-continuationtoken". Опустите этот параметр, чтобы получить первый пакет тестовых переменных.

Возвращаемое значение

Promise<PagedList<TestVariable>>

removeTestCasesFromSuite(string, number, number, string)

Удаляет тестовые случаи из набора на основе списка предоставленных идентификаторов тестовых случаев.

function removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, из которого следует удалить тестовые случаи.

suiteId: number

Идентификатор набора тестов, из которого следует удалить тестовые случаи.

testCaseIds: string

Идентификаторы тестовых случаев, которые необходимо удалить.

Возвращаемое значение

Promise<void>

removeTestCasesListFromSuite(string, number, number, string)

Удаляет тестовые случаи из набора на основе списка предоставленных идентификаторов тестовых случаев. Этот API можно использовать для удаления большего количества тестовых случаев.

function removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>

Параметры

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, из которого следует удалить тестовые случаи.

suiteId: number

Идентификатор набора тестов, из которого следует удалить тестовые случаи.

testIds: string

Строка идентификаторов тестовых случаев, разделенных запятыми, которые необходимо удалить.

Возвращаемое значение

Promise<void>

reorderSuiteEntries(SuiteEntryUpdateParams[], string, number)

Переупорядочение записей набора тестов в наборе тестов.

function reorderSuiteEntries(suiteEntries: SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<SuiteEntry[]>

Параметры

suiteEntries: SuiteEntryUpdateParams[]

Список Объектов SuiteEntry для изменения порядка.

project: string

Идентификатор проекта или имя проекта

suiteId: number

Идентификатор родительского набора тестов.

Возвращаемое значение

Promise<SuiteEntry[]>

restoreDeletedTestPlan(TestPlanAndSuiteRestoreModel, string, number)

Восстановление удаленного плана тестирования

function restoreDeletedTestPlan(restoreModel: TestPlanAndSuiteRestoreModel, project: string, planId: number): Promise<void>

Параметры

restoreModel: TestPlanAndSuiteRestoreModel

Модель, содержащая сведения о восстановлении

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования для восстановления

Возвращаемое значение

Promise<void>

restoreDeletedTestSuite(TestPlanAndSuiteRestoreModel, string, number)

Восстановление удаленного набора тестов

function restoreDeletedTestSuite(payload: TestPlanAndSuiteRestoreModel, project: string, suiteId: number): Promise<void>

Параметры

payload: TestPlanAndSuiteRestoreModel

Модель, содержащая сведения о восстановлении

project: string

Идентификатор проекта или имя проекта

suiteId: number

Идентификатор набора тестов для восстановления

Возвращаемое значение

Promise<void>

updateSuiteTestCases(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Обновление конфигураций для тестовых случаев

function updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestCase[]>

Параметры

suiteTestCaseCreateUpdateParameters: SuiteTestCaseCreateUpdateParameters[]

Объект SuiteTestCaseCreateUpdateParameters.

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, до которого необходимо обновить тестовые случаи.

suiteId: number

Идентификатор набора тестов, до которого необходимо обновить тестовые случаи.

Возвращаемое значение

Promise<TestCase[]>

updateTestConfiguration(TestConfigurationCreateUpdateParameters, string, number)

Обновите тестовую конфигурацию по ее идентификатору.

function updateTestConfiguration(testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters, project: string, testConfiguartionId: number): Promise<TestConfiguration>

Параметры

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

Идентификатор проекта или имя проекта

testConfiguartionId: number

Идентификатор обновляемой конфигурации теста.

Возвращаемое значение

Promise<TestConfiguration>

updateTestPlan(TestPlanUpdateParams, string, number)

Обновление плана тестирования.

function updateTestPlan(testPlanUpdateParams: TestPlanUpdateParams, project: string, planId: number): Promise<TestPlan>

Параметры

testPlanUpdateParams: TestPlanUpdateParams

Объект testPlanUpdateParams. TestPlanUpdateParams

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор обновляемого плана тестирования.

Возвращаемое значение

Promise<TestPlan>

updateTestPoints(TestPointUpdateParams[], string, number, number, boolean, boolean)

Обновление тестовых точек. Используется для сброса активной тестовой точки, обновления результатов точки тестирования или обновления тестировщика точки тестирования.

function updateTestPoints(testPointUpdateParams: TestPointUpdateParams[], project: string, planId: number, suiteId: number, includePointDetails?: boolean, returnIdentityRef?: boolean): Promise<TestPoint[]>

Параметры

testPointUpdateParams: TestPointUpdateParams[]

Объект TestPointUpdateParams.

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, для которого запрашиваются тестовые точки.

suiteId: number

Идентификатор набора тестов, для которого запрашиваются тестовые точки.

includePointDetails: boolean

Если задано значение false, будет получать меньшие полезные данные, содержащие только основные сведения об объекте точки тестирования.

returnIdentityRef: boolean

Если задано значение true, возвращает поле AssignedTo в TestCaseReference как объект IdentityRef.

Возвращаемое значение

Promise<TestPoint[]>

updateTestSuite(TestSuiteUpdateParams, string, number, number)

Обновление набора тестов.

function updateTestSuite(testSuiteUpdateParams: TestSuiteUpdateParams, project: string, planId: number, suiteId: number): Promise<TestSuite>

Параметры

testSuiteUpdateParams: TestSuiteUpdateParams

Параметры для updation набора

project: string

Идентификатор проекта или имя проекта

planId: number

Идентификатор плана тестирования, содержащего наборы.

suiteId: number

Идентификатор родительского набора.

Возвращаемое значение

Promise<TestSuite>

updateTestVariable(TestVariableCreateUpdateParameters, string, number)

Обновите тестовую переменную по ее идентификатору.

function updateTestVariable(testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters, project: string, testVariableId: number): Promise<TestVariable>

Параметры

testVariableCreateUpdateParameters: TestVariableCreateUpdateParameters

TestVariableCreateUpdateParameters

project: string

Идентификатор проекта или имя проекта

testVariableId: number

Идентификатор обновляемой тестовой переменной.

Возвращаемое значение

Promise<TestVariable>

Поделиться через

TestPlanRestClient class

Конструкторы

Методы

Сведения о конструкторе

TestPlanRestClient(IVssRestClientOptions)

Параметры

Сведения о методе

addTestCasesToSuite(SuiteTestCaseCreateUpdateParameters[], string, number, number)

Параметры

Возвращаемое значение

cloneTestCase(CloneTestCaseParams, string)

Параметры

Возвращаемое значение

cloneTestPlan(CloneTestPlanParams, string, boolean)

Параметры

Возвращаемое значение

cloneTestSuite(CloneTestSuiteParams, string, boolean)

Параметры

Возвращаемое значение

createBulkTestSuites(TestSuiteCreateParams[], string, number, number)

Параметры

Возвращаемое значение

createTestConfiguration(TestConfigurationCreateUpdateParameters, string)

Параметры

Возвращаемое значение

createTestPlan(TestPlanCreateParams, string)

Параметры

Возвращаемое значение

createTestSuite(TestSuiteCreateParams, string, number)

Параметры

Возвращаемое значение

createTestVariable(TestVariableCreateUpdateParameters, string)

Параметры

Возвращаемое значение

deleteTestCase(string, number)

Параметры

Возвращаемое значение

deleteTestConfguration(string, number)

Параметры

Возвращаемое значение

deleteTestPlan(string, number)

Параметры

Возвращаемое значение

deleteTestSuite(string, number, number)

Параметры

Возвращаемое значение

deleteTestVariable(string, number)

Параметры

Возвращаемое значение

exportTestCases(ExportTestCaseParams, string)

Параметры

Возвращаемое значение

getCloneInformation(string, number)

Параметры

Возвращаемое значение

getPoints(string, number, number, string, boolean, boolean)

Параметры

Возвращаемое значение

getPointsList(string, number, number, string, string, string, boolean, boolean, boolean)

Параметры

Возвращаемое значение

getSuiteCloneInformation(string, number)

Параметры

Возвращаемое значение

getSuiteEntries(string, number, SuiteEntryTypes)

Параметры

Возвращаемое значение

getSuitesByTestCaseId(number)

Параметры

Возвращаемое значение

getTestCase(string, number, number, string, string, boolean)

Параметры

Возвращаемое значение

getTestCaseCloneInformation(string, number)

Параметры

Возвращаемое значение

getTestCaseList(string, number, number, string, string, string, string, boolean, boolean, ExcludeFlags, boolean)

Параметры

Возвращаемое значение