Test Plans - Create

Referência

Service:: Test

API Version:: 5.0

Crie um plano de teste.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '5.0' para usar esta versão da API.

Corpo da solicitação

Nome	Tipo	Description
area	ShallowReference	Caminho de área ao qual o plano de teste pertence. Isso deve ser definido como o caminho da área da equipe que trabalha neste plano de teste.
build	ShallowReference	ID de build do build cuja qualidade é testada pelos testes neste plano de teste. Para testes automatizados, essa ID de build é usada para localizar os binários de teste que contêm métodos de teste automatizados.
buildDefinition	ShallowReference	A Definição de Build que gera um build associado a esse plano de teste.
configurationIds	integer[]	IDs de configurações a serem aplicadas quando novos conjuntos de testes e casos de teste forem adicionados ao plano de teste.
description	string	Descrição do plano de teste.
endDate	string	Data de término do plano de teste.
iteration	string	Caminho de iteração atribuído ao plano de teste. Isso indica quando a iteração de destino pela qual o teste neste plano deve ser concluído e o produto está pronto para ser lançado.
name	string	Nome do plano de teste.
owner	IdentityRef	Proprietário do plano de teste.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment a ser usado para implantar o build e executar testes automatizados desse plano de teste.
startDate	string	Data de início do plano de teste.
state	string	Estado do plano de teste.
testOutcomeSettings	TestOutcomeSettings	Configurações de resultado de teste

Respostas

Nome	Tipo	Description
200 OK	TestPlan	operação bem-sucedida

Segurança

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

Nome	Description
vso.test_write	Concede a capacidade de ler, criar e atualizar planos de teste, casos, resultados e outros artefatos relacionados ao gerenciamento de testes.

Exemplos

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"
}

Definições

Nome	Description
IdentityRef
PlanUpdateModel	Uma classe de modelo usada para criar e atualizar planos de teste.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ReleaseEnvironmentDefinitionReference	Referência ao recurso de ambiente de lançamento.
ShallowReference	Uma referência abstrata a algum outro recurso. Essa classe é usada para fornecer os contratos de dados de build com uma maneira uniforme de referenciar outros recursos de uma maneira que fornece fácil passagem por meio de links.
TestOutcomeSettings	Configurações de resultado do teste
TestPlan	O recurso de plano de teste.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto do grafo entre contas e organizações.
directoryAlias	string
displayName	string	Este é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

PlanUpdateModel

Uma classe de modelo usada para criar e atualizar planos de teste.

Nome	Tipo	Description
area	ShallowReference	Caminho de área ao qual o plano de teste pertence. Isso deve ser definido como o caminho da área da equipe que trabalha neste plano de teste.
build	ShallowReference	ID de build do build cuja qualidade é testada pelos testes neste plano de teste. Para testes automatizados, essa ID de build é usada para localizar os binários de teste que contêm métodos de teste automatizados.
buildDefinition	ShallowReference	A Definição de Build que gera um build associado a esse plano de teste.
configurationIds	integer[]	IDs de configurações a serem aplicadas quando novos conjuntos de testes e casos de teste forem adicionados ao plano de teste.
description	string	Descrição do plano de teste.
endDate	string	Data de término do plano de teste.
iteration	string	Caminho de iteração atribuído ao plano de teste. Isso indica quando a iteração de destino pela qual o teste neste plano deve ser concluído e o produto está pronto para ser lançado.
name	string	Nome do plano de teste.
owner	IdentityRef	Proprietário do plano de teste.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment a ser usado para implantar o build e executar testes automatizados desse plano de teste.
startDate	string	Data de início do plano de teste.
state	string	Estado do plano de teste.
testOutcomeSettings	TestOutcomeSettings	Configurações de resultado de teste

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

ReleaseEnvironmentDefinitionReference

Referência ao recurso de ambiente de lançamento.

Nome	Tipo	Description
definitionId	integer	ID da definição de versão que contém a definição do ambiente de versão.
environmentDefinitionId	integer	ID da definição do ambiente de versão.

ShallowReference

Uma referência abstrata a algum outro recurso. Essa classe é usada para fornecer os contratos de dados de build com uma maneira uniforme de referenciar outros recursos de uma maneira que fornece fácil passagem por meio de links.

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso vinculado (nome da definição, nome do controlador etc.)
url	string	Link http completo para o recurso

TestOutcomeSettings

Configurações de resultado do teste

Nome	Tipo	Description
syncOutcomeAcrossSuites	boolean	Valor para configurar como os resultados de teste para os mesmos testes entre conjuntos são mostrados

TestPlan

O recurso de plano de teste.

Nome	Tipo	Description
area	ShallowReference	Área do plano de teste.
build	ShallowReference	Compilação a ser testada.
buildDefinition	ShallowReference	A Definição de Build que gera um build associado a esse plano de teste.
description	string	Descrição do plano de teste.
endDate	string	Data de término do plano de teste.
id	integer	ID do plano de teste.
iteration	string	Caminho de iteração do plano de teste.
name	string	Nome do plano de teste.
owner	IdentityRef	Proprietário do plano de teste.
previousBuild	ShallowReference	Uma referência abstrata a algum outro recurso. Essa classe é usada para fornecer os contratos de dados de build com uma maneira uniforme de referenciar outros recursos de uma maneira que fornece fácil passagem por meio de links.
project	ShallowReference	Projeto que contém o plano de teste.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment a ser usado para implantar o build e executar testes automatizados desse plano de teste.
revision	integer	Revisão do plano de teste.
rootSuite	ShallowReference	Conjunto de testes raiz do plano de teste.
startDate	string	Data de início do plano de teste.
state	string	Estado do plano de teste.
testOutcomeSettings	TestOutcomeSettings	Valor para configurar como os mesmos testes em conjuntos de testes em um plano de teste precisam se comportar
updatedBy	IdentityRef
updatedDate	string
url	string	URL do recurso de plano de teste.

Partilhar via

Test Plans - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Scopes

Exemplos

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

Definições

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Recursos adicionais