Test Plans - Create

Ссылка

Служба:: Test Plan

Версия API:: 7.1

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

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

Параметры URI

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

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

Имя	Тип	Описание
areaPath	string	Область тестового плана.
buildDefinition	BuildDefinitionReference	Определение сборки, которое создает сборку, связанную с этим тестовый план.
buildId	integer (int32)	Сборка для тестирования.
description	string	Описание тестового плана.
endDate	string (date-time)	Дата окончания плана тестирования.
iteration	string	Путь итерации плана тестирования.
name	string	Имя тестового плана.
owner	IdentityRef	Владелец тестового плана.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Среда выпуска, используемая для развертывания сборки и запуска автоматических тестов из этого тестового плана.
startDate	string (date-time)	Дата начала для тестового плана.
state	string	Состояние тестового плана.
testOutcomeSettings	TestOutcomeSettings	Значение для настройки того, как те же тесты в наборах тестов в плане тестирования должны вести себя

Ответы

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

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

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

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

Примеры

Create a test plan with all details.

Create a test plan with name, area path and iteration.

Create a test plan with all details.

Образец запроса

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans?api-version=7.1

{
  "name": "newCreatedPlan2",
  "areaPath": "sampleProject\\Team1",
  "description": "description of the test plan",
  "startDate": "2018-08-19T20:49:15.8884886+05:30",
  "endDate": "2018-08-26T20:49:15.8884886+05:30",
  "iteration": "sampleProject\\Iteration 2",
  "owner": null,
  "state": "Inactive",
  "buildId": 3,
  "buildDefinition": {
    "id": 2,
    "name": ""
  },
  "releaseEnvironmentDefinition": {
    "definitionId": 1,
    "environmentDefinitionId": 1
  },
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

Пример ответа

Код состояния:: 200

{
  "id": 31,
  "project": {
    "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
    "name": "sampleProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "updatedDate": "2018-08-17T15:19:16.993Z",
  "updatedBy": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "rootSuite": {
    "id": 32,
    "name": "newCreatedPlan2",
    "plan": {
      "id": 31,
      "name": "newCreatedPlan2"
    }
  },
  "_links": {
    "_self": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/31"
    },
    "clientUrl": {
      "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=31"
    },
    "rootSuite": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/31/Suites/32"
    },
    "build": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Builds/3"
    },
    "buildDefinition": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Definitions/2"
    }
  },
  "revision": 2,
  "name": "newCreatedPlan2",
  "areaPath": "sampleProject\\Team1",
  "description": "description of the test plan",
  "startDate": "2018-08-19T20:49:15.8884886+05:30",
  "endDate": "2018-08-26T20:49:15.8884886+05:30",
  "iteration": "sampleProject\\Iteration 2",
  "owner": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "state": "Inactive",
  "buildId": 3,
  "buildDefinition": {
    "id": 2,
    "name": ""
  },
  "releaseEnvironmentDefinition": {
    "definitionId": 1,
    "environmentDefinitionId": 1
  },
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

Create a test plan with name, area path and iteration.

Образец запроса

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans?api-version=7.1

{
  "name": "newCreatedPlan1",
  "areaPath": "sampleProject\\Team1",
  "iteration": "sampleProject\\Iteration 2",
  "owner": null
}

Пример ответа

Код состояния:: 200

{
  "id": 29,
  "project": {
    "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
    "name": "sampleProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "updatedDate": "2018-08-17T15:19:13.967Z",
  "updatedBy": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "rootSuite": {
    "id": 30,
    "name": "newCreatedPlan1",
    "plan": {
      "id": 29,
      "name": "newCreatedPlan1"
    }
  },
  "_links": {
    "_self": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/29"
    },
    "clientUrl": {
      "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=29"
    },
    "rootSuite": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/29/Suites/30"
    }
  },
  "revision": 1,
  "name": "newCreatedPlan1",
  "areaPath": "sampleProject\\Team1",
  "startDate": "2018-08-17T15:19:13.6734848Z",
  "endDate": "2018-08-24T15:19:13.6734848Z",
  "iteration": "sampleProject\\Iteration 2",
  "owner": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "state": "Active",
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": false
  }
}

Определения

Имя	Описание
BuildDefinitionReference	Ресурс справочника по определению сборки
IdentityRef
ProjectState	Состояние проекта.
ProjectVisibility	Видимость проекта.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ReleaseEnvironmentDefinitionReference	Ссылка на ресурс среды выпуска.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
TestOutcomeSettings	Параметры результатов теста
TestPlan	Ресурс плана тестирования.
TestPlanCreateParams	Тестовый план создает параметры.
TestSuiteReference	Эталонный ресурс набора тестов.

BuildDefinitionReference

Object

Ресурс справочника по определению сборки

Имя	Тип	Описание
id	integer (int32)	Идентификатор определения сборки
name	string	Имя определения сборки

IdentityRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь Graph в записи "self" словаря IdentityRef "_links"
displayName	string	Это не уникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в исходном поставщике.
id	string
imageUrl	string	Не рекомендуется . Доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемый — можно получить, запросив состояние членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links"
isAadIdentity	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве стандартных реализаций ToIdentityRef
uniqueName	string	Не рекомендуется — вместо этого используйте domain+PrincipalName
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

ProjectState

Перечисление

Состояние проекта.

Значение	Описание
all	Все проекты независимо от состояния, кроме deleted.
createPending	Проект был поставлен в очередь для создания, но процесс еще не запущен.
deleted	Проект удален.
deleting	Проект находится в процессе удаления.
new	Проект находится в процессе создания.
unchanged	Проект не был изменен.
wellFormed	Проект полностью создан и готов к использованию.

ProjectVisibility

Перечисление

Видимость проекта.

Значение	Описание
private	Проект отображается только пользователям с явным доступом.
public	Проект виден всем.

ReferenceLinks

Object

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

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

ReleaseEnvironmentDefinitionReference

Object

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

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

TeamProjectReference

Object

Представляет неглубокую ссылку на TeamProject.

Имя	Тип	Описание
abbreviation	string	Сокращение проекта.
defaultTeamImageUrl	string	URL-адрес образа удостоверения группы по умолчанию.
description	string	Описание проекта (если таковой есть).
id	string (uuid)	Идентификатор проекта.
lastUpdateTime	string (date-time)	Время последнего обновления проекта.
name	string	Имя проекта.
revision	integer (int64)	Редакция проекта.
state	ProjectState	Состояние проекта.
url	string	URL-адрес полной версии объекта.
visibility	ProjectVisibility	Видимость проекта.

TestOutcomeSettings

Object

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

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

TestPlan

Object

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

Имя	Тип	Описание
_links	ReferenceLinks	Соответствующие ссылки
areaPath	string	Область тестового плана.
buildDefinition	BuildDefinitionReference	Определение сборки, которое создает сборку, связанную с этим тестовый план.
buildId	integer (int32)	Сборка для тестирования.
description	string	Описание тестового плана.
endDate	string (date-time)	Дата окончания плана тестирования.
id	integer (int32)	Идентификатор тестового плана.
iteration	string	Путь итерации плана тестирования.
name	string	Имя тестового плана.
owner	IdentityRef	Владелец тестового плана.
previousBuildId	integer (int32)	Предыдущий идентификатор сборки, связанный с планом тестирования
project	TeamProjectReference	Проект, содержащий план тестирования.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Среда выпуска, используемая для развертывания сборки и запуска автоматических тестов из этого тестового плана.
revision	integer (int32)	Редакция тестового плана.
rootSuite	TestSuiteReference	Корневой набор тестов плана тестирования.
startDate	string (date-time)	Дата начала для тестового плана.
state	string	Состояние тестового плана.
testOutcomeSettings	TestOutcomeSettings	Значение для настройки того, как те же тесты в наборах тестов в плане тестирования должны вести себя
updatedBy	IdentityRef	Справочник по удостоверениям для последнего обновления тестового плана
updatedDate	string (date-time)	Обновленная дата плана тестирования

TestPlanCreateParams

Object

Тестовый план создает параметры.

Имя	Тип	Описание
areaPath	string	Область тестового плана.
buildDefinition	BuildDefinitionReference	Определение сборки, которое создает сборку, связанную с этим тестовый план.
buildId	integer (int32)	Сборка для тестирования.
description	string	Описание тестового плана.
endDate	string (date-time)	Дата окончания плана тестирования.
iteration	string	Путь итерации плана тестирования.
name	string	Имя тестового плана.
owner	IdentityRef	Владелец тестового плана.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Среда выпуска, используемая для развертывания сборки и запуска автоматических тестов из этого тестового плана.
startDate	string (date-time)	Дата начала для тестового плана.
state	string	Состояние тестового плана.
testOutcomeSettings	TestOutcomeSettings	Значение для настройки того, как те же тесты в наборах тестов в плане тестирования должны вести себя

TestSuiteReference

Object

Эталонный ресурс набора тестов.

Имя	Тип	Описание
id	integer (int32)	Идентификатор набора тестов.
name	string	Имя набора тестов.

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

Test Plans - Create

Параметры URI

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

Ответы

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

oauth2

Области

Примеры

Create a test plan with all details.

Образец запроса

Пример ответа

Create a test plan with name, area path and iteration.

Образец запроса

Пример ответа

Определения

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference