Test Plans - Create

Ссылка

Service:: Test

API Version:: 5.0

Создайте план тестирования.

POST https://dev.azure.com/{organization}/{project}/_apis/test/plans?api-version=5.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 5.0.

Текст запроса

Имя	Тип	Описание
area	ShallowReference	Путь к области, к которой относится план тестирования. Для этого параметра следует задать путь к области команды, которая работает над этим планом тестирования.
build	ShallowReference	Идентификатор сборки сборки, качество которой проверяется тестами в этом плане тестирования. Для автоматического тестирования этот идентификатор сборки используется для поиска двоичных файлов теста, содержащих автоматизированные методы тестирования.
buildDefinition	ShallowReference	Определение сборки, создающее сборку, связанную с этим планом тестирования.
configurationIds	integer[]	Идентификаторы конфигураций, применяемых при добавлении новых наборов тестов и тестовых случаев в план тестирования.
description	string	Описание плана тестирования.
endDate	string	Дата окончания плана тестирования.
iteration	string	Путь итерации, назначенный плану тестирования. Это указывает, когда целевая итерация, с помощью которой предполагается завершить тестирование в этом плане, и продукт готов к выпуску.
name	string	Имя плана тестирования.
owner	IdentityRef	Владелец плана тестирования.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Среда выпуска, используемая для развертывания сборки и запуска автоматических тестов из этого плана тестирования.
startDate	string	Дата начала плана тестирования.
state	string	Состояние плана тестирования.
testOutcomeSettings	TestOutcomeSettings	Параметры результатов теста

Ответы

Имя	Тип	Описание
200 OK	TestPlan	успешная операция

Безопасность

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Имя	Описание
vso.test_write	Предоставляет возможность читать, создавать и обновлять планы тестирования, случаи, результаты и другие артефакты, связанные с управлением тестами.

Примеры

Create a test plan in an area and iteration.

Create a test plan with a description.

Create a test plan with start date and end date.

Create a test plan in an area and iteration.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?api-version=5.0

{
  "name": "ANewPlan",
  "area": {
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1"
}

Sample Response

Status code:: 200

{
  "id": 16,
  "name": "ANewPlan",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/16",
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "area": {
    "id": "411",
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "startDate": "2014-05-06T13:43:02.803578Z",
  "endDate": "2014-05-13T13:43:02.803578Z",
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1",
  "updatedDate": "2014-05-06T13:43:02.187Z",
  "updatedBy": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "owner": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "revision": 1,
  "state": "Active",
  "rootSuite": {
    "id": "33",
    "name": "ANewPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/16/Suites/33"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=16"
}

Create a test plan with a description.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?api-version=5.0

{
  "name": "newCreatedPlan",
  "description": "This is a new test plan"
}

Sample Response

Status code:: 200

{
  "id": 15,
  "name": "newCreatedPlan",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/15",
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "area": {
    "id": "343",
    "name": "Fabrikam-Fiber-TFVC"
  },
  "description": "This is a new test plan",
  "startDate": "2014-05-06T13:42:59.3008007Z",
  "endDate": "2014-05-13T13:42:59.3008007Z",
  "iteration": "Fabrikam-Fiber-TFVC",
  "updatedDate": "2014-05-06T13:42:58.71Z",
  "updatedBy": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "owner": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "revision": 1,
  "state": "Active",
  "rootSuite": {
    "id": "32",
    "name": "newCreatedPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/15/Suites/32"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=15"
}

Create a test plan with start date and end date.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans?api-version=5.0

{
  "name": "ANewPlan",
  "startDate": "2014-05-01",
  "endDate": "2014-05-10"
}

Sample Response

Status code:: 200

{
  "id": 17,
  "name": "ANewPlan",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/17",
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "area": {
    "id": "343",
    "name": "Fabrikam-Fiber-TFVC"
  },
  "startDate": "2014-05-01T00:00:00Z",
  "endDate": "2014-05-10T00:00:00Z",
  "iteration": "Fabrikam-Fiber-TFVC",
  "updatedDate": "2014-05-06T13:43:04.743Z",
  "updatedBy": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "owner": {
    "id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "displayName": "Fabrikam Fiber",
    "uniqueName": "fabrikamfiber1@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
  },
  "revision": 1,
  "state": "Active",
  "rootSuite": {
    "id": "34",
    "name": "ANewPlan",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/17/Suites/34"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=17"
}

Определения

Имя	Описание
IdentityRef
PlanUpdateModel	Класс модели, используемый для создания и обновления планов тестирования.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ReleaseEnvironmentDefinitionReference	Ссылка на ресурс среды выпуска.
ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
TestOutcomeSettings	Параметры результатов теста
TestPlan	Ресурс плана тестирования.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

PlanUpdateModel

Класс модели, используемый для создания и обновления планов тестирования.

Имя	Тип	Описание
area	ShallowReference	Путь к области, к которой относится план тестирования. Для этого параметра следует задать путь к области команды, которая работает над этим планом тестирования.
build	ShallowReference	Идентификатор сборки сборки, качество которой проверяется тестами в этом плане тестирования. Для автоматического тестирования этот идентификатор сборки используется для поиска двоичных файлов теста, содержащих автоматизированные методы тестирования.
buildDefinition	ShallowReference	Определение сборки, создающее сборку, связанную с этим планом тестирования.
configurationIds	integer[]	Идентификаторы конфигураций, применяемых при добавлении новых наборов тестов и тестовых случаев в план тестирования.
description	string	Описание плана тестирования.
endDate	string	Дата окончания плана тестирования.
iteration	string	Путь итерации, назначенный плану тестирования. Это указывает, когда целевая итерация, с помощью которой предполагается завершить тестирование в этом плане, и продукт готов к выпуску.
name	string	Имя плана тестирования.
owner	IdentityRef	Владелец плана тестирования.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Среда выпуска, используемая для развертывания сборки и запуска автоматических тестов из этого плана тестирования.
startDate	string	Дата начала плана тестирования.
state	string	Состояние плана тестирования.
testOutcomeSettings	TestOutcomeSettings	Параметры результатов теста

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

ReleaseEnvironmentDefinitionReference

Ссылка на ресурс среды выпуска.

Имя	Тип	Описание
definitionId	integer	Идентификатор определения выпуска, содержащего определение среды выпуска.
environmentDefinitionId	integer	Идентификатор определения среды выпуска.

ShallowReference

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

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя связанного ресурса (имя определения, имя контроллера и т. д.)
url	string	Полная ссылка http на ресурс

TestOutcomeSettings

Параметры результатов теста

Имя	Тип	Описание
syncOutcomeAcrossSuites	boolean	Значение для настройки отображения результатов теста для одинаковых тестов в разных наборах

TestPlan

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

Имя	Тип	Описание
area	ShallowReference	Область плана тестирования.
build	ShallowReference	Сборка для тестирования.
buildDefinition	ShallowReference	Определение сборки, создающее сборку, связанную с этим планом тестирования.
description	string	Описание плана тестирования.
endDate	string	Дата окончания плана тестирования.
id	integer	Идентификатор плана тестирования.
iteration	string	Путь итерации плана тестирования.
name	string	Имя плана тестирования.
owner	IdentityRef	Владелец плана тестирования.
previousBuild	ShallowReference	Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
project	ShallowReference	Проект, содержащий план тестирования.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Среда выпуска, используемая для развертывания сборки и запуска автоматических тестов из этого плана тестирования.
revision	integer	Пересмотр плана тестирования.
rootSuite	ShallowReference	Корневой набор тестов плана тестирования.
startDate	string	Дата начала плана тестирования.
state	string	Состояние плана тестирования.
testOutcomeSettings	TestOutcomeSettings	Значение для настройки того, как должны работать одни и те же тесты в наборах тестов в рамках плана тестирования
updatedBy	IdentityRef
updatedDate	string
url	string	URL-адрес ресурса плана тестирования.

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

Test Plans - Create

Параметры URI

Текст запроса

Ответы

Безопасность

oauth2

Scopes

Примеры

Create a test plan in an area and iteration.

Sample Request

Sample Response

Create a test plan with a description.

Sample Request

Sample Response

Create a test plan with start date and end date.

Sample Request

Sample Response

Определения

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Дополнительные ресурсы