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)	Создание наборов тестов на основе массовых требований.
createTestConfiguration(TestConfigurationCreateUpdateParameters, string)	Создайте тестовую конфигурацию.
createTestPlan(TestPlanCreateParams, string)	Создайте тестовый план.
createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, 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)	Экспортирует набор тестовых вариантов из набора в файл. Поддерживаемые в настоящее время форматы: xlsx
getCloneInformation(string, number)	Получение сведений о клоне.
getDeletedTestPlans(string, string)	Получение списка удаленных планов тестирования
getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)	Получите удаленные наборы тестов для плана тестирования.
getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)	Получение удаленных наборов тестов в проекте.
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 Подробная информация о теле TestPlanCloneRequest

project: string

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

deepClone: boolean

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

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

Promise<CloneTestPlanOperationInformation>

cloneTestSuite(CloneTestSuiteParams, string, boolean)

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

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

Параметры

cloneRequestBody: CloneTestSuiteParams

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

project: string

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

deepClone: boolean

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

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

Promise<CloneTestSuiteOperationInformation>

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

Создание наборов тестов на основе массовых требований.

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)

Создайте тестовую конфигурацию.

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

Параметры

testConfigurationCreateUpdateParameters: TestConfigurationCreateUpdateParameters

TestConfigurationCreateUpdateParameters

project: string

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

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

Promise<TestConfiguration>

createTestPlan(TestPlanCreateParams, string)

Создайте тестовый план.

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

Параметры

testPlanCreateParams: TestPlanCreateParams

Объект testPlanCreateParams. TestPlanCreateParams

project: string

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

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

Promise<TestPlan>

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, string)

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

function createTestPlanWithTestCases(creationParams: TestPlanWithTestCasesCreateParams, project: string): Promise<boolean>

Параметры

creationParams: TestPlanWithTestCasesCreateParams

Параметры для создания тест-плана и тест-кейсов.

project: string

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

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

Promise<boolean>

createTestSuite(TestSuiteCreateParams, string, number)

Создайте набор тестов.

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

Параметры

testSuiteCreateParams: TestSuiteCreateParams

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

project: string

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

planId: number

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

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

Promise<TestSuite>

createTestVariable(TestVariableCreateUpdateParameters, string)

Создайте тестовую переменную.

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>

getDeletedTestPlans(string, string)

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

function getDeletedTestPlans(project: string, continuationToken?: string): Promise<PagedList<TestPlan>>

Параметры

project: string

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

continuationToken: string

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

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

Promise<PagedList<TestPlan>>

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

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

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

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

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

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

Параметры

project: string

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

expand: SuiteExpand

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

continuationToken: string

asTreeView: boolean

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

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

Promise<PagedList<TestSuite>>

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

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

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

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

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)

Параметры

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

createTestPlanWithTestCases(TestPlanWithTestCasesCreateParams, 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)

Параметры

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

getDeletedTestPlans(string, string)

Параметры

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

getDeletedTestSuitesForPlan(string, number, SuiteExpand, string, boolean)

Параметры

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

getDeletedTestSuitesForProject(string, SuiteExpand, string, boolean)

Параметры

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

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

Параметры

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

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

Параметры

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

getSuiteCloneInformation(string, number)

Параметры

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

getSuiteEntries(string, number, SuiteEntryTypes)

Параметры

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