Test Plans - Create

Referência

Serviço:: Test Plan

Versão da API:: 7.1

Crie um plano de teste.

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

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 '7.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
areaPath	string	Área do plano de teste.
buildDefinition	BuildDefinitionReference	A Definição de Build que gera um build associado a este plano de teste.
buildId	integer (int32)	Compilação a ser testada.
description	string	Descrição do plano de teste.
endDate	string (date-time)	Data de término 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.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Ambiente de versão a ser usado para implantar o build e executar testes automatizados desse plano de teste.
startDate	string (date-time)	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

Respostas

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

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

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 with all details.

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

Create a test plan with all details.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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.

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:: 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
  }
}

Definições

Nome	Description
BuildDefinitionReference	O recurso de referência de definição de build
IdentityRef
ProjectState	Estado do projeto.
ProjectVisibility	Visibilidade do projeto.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ReleaseEnvironmentDefinitionReference	Referência ao recurso de ambiente de lançamento.
TeamProjectReference	Representa uma referência superficial a um TeamProject.
TestOutcomeSettings	Configurações de resultado do teste
TestPlan	O recurso de plano de teste.
TestPlanCreateParams	O plano de teste cria parâmetros.
TestSuiteReference	O recurso de referência do conjunto de testes.

BuildDefinitionReference

Objeto

O recurso de referência de definição de build

Nome	Tipo	Description
id	integer (int32)	ID da definição de build
name	string	Nome da definição de build

IdentityRef

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	Este 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 de grafo em contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
displayName	string	Esse é 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	Preterido – Disponível na entrada "avatar" do dicionário "_links" do IdentityRef
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser adiado do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido - não em uso na maioria das implementações pré-existentes de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ProjectState

Enumeração

Estado do projeto.

Valor	Description
all	Todos os projetos, independentemente do estado, exceto Excluídos.
createPending	O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado.
deleted	O projeto foi excluído.
deleting	O Project está em processo de exclusão.
new	O Project está em processo de criação.
unchanged	O projeto não foi alterado.
wellFormed	O Project é completamente criado e pronto para uso.

ProjectVisibility

Enumeração

Visibilidade do projeto.

Valor	Description
private	O projeto só é visível para usuários com acesso explícito.
public	O projeto é visível para todos.

ReferenceLinks

Objeto

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

Objeto

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

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

TeamProjectReference

Objeto

Representa uma referência superficial a um TeamProject.

Nome	Tipo	Description
abbreviation	string	Abreviação do projeto.
defaultTeamImageUrl	string	Url para imagem de identidade de equipe padrão.
description	string	A descrição do projeto (se houver).
id	string (uuid)	Identificador de projeto.
lastUpdateTime	string (date-time)	Hora da última atualização do projeto.
name	string	Nome do projeto.
revision	integer (int64)	Revisão do projeto.
state	ProjectState	Estado do projeto.
url	string	Url para a versão completa do objeto.
visibility	ProjectVisibility	Visibilidade do projeto.

TestOutcomeSettings

Objeto

Configurações de resultado do teste

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

TestPlan

Objeto

O recurso de plano de teste.

Nome	Tipo	Description
_links	ReferenceLinks	Links relevantes
areaPath	string	Área do plano de teste.
buildDefinition	BuildDefinitionReference	A Definição de Build que gera um build associado a este plano de teste.
buildId	integer (int32)	Compilação a ser testada.
description	string	Descrição do plano de teste.
endDate	string (date-time)	Data de término do plano de teste.
id	integer (int32)	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.
previousBuildId	integer (int32)	ID de build anterior associada ao plano de teste
project	TeamProjectReference	Projeto que contém o plano de teste.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Ambiente de versão a ser usado para implantar o build e executar testes automatizados desse plano de teste.
revision	integer (int32)	Revisão do plano de teste.
rootSuite	TestSuiteReference	Conjunto de testes raiz do plano de teste.
startDate	string (date-time)	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	Referência de identidade para a última atualização do plano de teste
updatedDate	string (date-time)	Data atualizada do plano de teste

TestPlanCreateParams

Objeto

O plano de teste cria parâmetros.

Nome	Tipo	Description
areaPath	string	Área do plano de teste.
buildDefinition	BuildDefinitionReference	A Definição de Build que gera um build associado a este plano de teste.
buildId	integer (int32)	Compilação a ser testada.
description	string	Descrição do plano de teste.
endDate	string (date-time)	Data de término 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.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Ambiente de versão a ser usado para implantar o build e executar testes automatizados desse plano de teste.
startDate	string (date-time)	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

TestSuiteReference

Objeto

O recurso de referência do conjunto de testes.

Nome	Tipo	Description
id	integer (int32)	ID do conjunto de testes.
name	string	Nome do conjunto de testes.

Compartilhar via

Test Plans - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

Create a test plan with all details.

Solicitação de exemplo

Resposta de exemplo

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

Solicitação de exemplo

Resposta de exemplo

Definições

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference