Test Plans - Create

Referencia

Service:: Test

API Version:: 5.0

Cree un plan de prueba.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
area	ShallowReference	Ruta de acceso del área a la que pertenece el plan de prueba. Debe establecerse en la ruta de acceso del área del equipo que funciona en este plan de prueba.
build	ShallowReference	Identificador de compilación de la compilación cuya calidad se prueba en las pruebas de este plan de prueba. Para las pruebas automatizadas, este identificador de compilación se usa para buscar los archivos binarios de prueba que contienen métodos de prueba automatizados.
buildDefinition	ShallowReference	Definición de compilación que genera una compilación asociada a este plan de prueba.
configurationIds	integer[]	Identificadores de configuraciones que se van a aplicar cuando se agregan nuevos conjuntos de pruebas y casos de prueba al plan de pruebas.
description	string	Descripción del plan de prueba.
endDate	string	Fecha de finalización del plan de prueba.
iteration	string	Ruta de acceso de iteración asignada al plan de prueba. Esto indica cuándo se debe completar la iteración de destino por la que se supone que las pruebas de este plan están completas y el producto está listo para su lanzamiento.
name	string	Nombre del plan de prueba.
owner	IdentityRef	Propietario del plan de prueba.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Entorno de versión que se usará para implementar la compilación y ejecutar pruebas automatizadas a partir de este plan de prueba.
startDate	string	Fecha de inicio del plan de prueba.
state	string	Estado del plan de prueba.
testOutcomeSettings	TestOutcomeSettings	Configuración del resultado de la prueba

Respuestas

Nombre	Tipo	Description
200 OK	TestPlan	operación correcta

Seguridad

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

Nombre	Description
vso.test_write	Concede la capacidad de leer, crear y actualizar planes de prueba, casos, resultados y otros artefactos relacionados con la administración de pruebas.

Ejemplos

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

Definiciones

Nombre	Description
IdentityRef
PlanUpdateModel	Clase de modelo usada para crear y actualizar planes de prueba.
ReferenceLinks	Clase que se va a representar una colección de vínculos de referencia de REST.
ReleaseEnvironmentDefinitionReference	Referencia al recurso del entorno de versión.
ShallowReference	Referencia abstracta a algún otro recurso. Esta clase se usa para proporcionar los contratos de datos de compilación con una manera uniforme de hacer referencia a otros recursos de una manera que proporciona un recorrido fácil a través de vínculos.
TestOutcomeSettings	Configuración del resultado de la prueba
TestPlan	Recurso del plan de prueba.

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

PlanUpdateModel

Clase de modelo usada para crear y actualizar planes de prueba.

Nombre	Tipo	Description
area	ShallowReference	Ruta de acceso del área a la que pertenece el plan de prueba. Debe establecerse en la ruta de acceso del área del equipo que funciona en este plan de prueba.
build	ShallowReference	Identificador de compilación de la compilación cuya calidad se prueba en las pruebas de este plan de prueba. Para las pruebas automatizadas, este identificador de compilación se usa para buscar los archivos binarios de prueba que contienen métodos de prueba automatizados.
buildDefinition	ShallowReference	Definición de compilación que genera una compilación asociada a este plan de prueba.
configurationIds	integer[]	Identificadores de configuraciones que se van a aplicar cuando se agregan nuevos conjuntos de pruebas y casos de prueba al plan de pruebas.
description	string	Descripción del plan de prueba.
endDate	string	Fecha de finalización del plan de prueba.
iteration	string	Ruta de acceso de iteración asignada al plan de prueba. Esto indica cuándo se debe completar la iteración de destino por la que se supone que las pruebas de este plan están completas y el producto está listo para su lanzamiento.
name	string	Nombre del plan de prueba.
owner	IdentityRef	Propietario del plan de prueba.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Entorno de versión que se usará para implementar la compilación y ejecutar pruebas automatizadas a partir de este plan de prueba.
startDate	string	Fecha de inicio del plan de prueba.
state	string	Estado del plan de prueba.
testOutcomeSettings	TestOutcomeSettings	Configuración del resultado de la prueba

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

ReleaseEnvironmentDefinitionReference

Referencia al recurso del entorno de versión.

Nombre	Tipo	Description
definitionId	integer	Identificador de la definición de versión que contiene la definición del entorno de versión.
environmentDefinitionId	integer	Identificador de la definición del entorno de versión.

ShallowReference

Referencia abstracta a algún otro recurso. Esta clase se usa para proporcionar los contratos de datos de compilación con una manera uniforme de hacer referencia a otros recursos de una manera que proporciona un recorrido fácil a través de vínculos.

Nombre	Tipo	Description
id	string	Identificador del recurso
name	string	Nombre del recurso vinculado (nombre de definición, nombre del controlador, etc.)
url	string	Vínculo http completo al recurso

TestOutcomeSettings

Configuración del resultado de la prueba

Nombre	Tipo	Description
syncOutcomeAcrossSuites	boolean	Valor para configurar cómo se muestran los resultados de las pruebas de las mismas pruebas entre conjuntos

TestPlan

Recurso del plan de prueba.

Nombre	Tipo	Description
area	ShallowReference	Área del plan de pruebas.
build	ShallowReference	Compilación que se va a probar.
buildDefinition	ShallowReference	Definición de compilación que genera una compilación asociada a este plan de prueba.
description	string	Descripción del plan de prueba.
endDate	string	Fecha de finalización del plan de prueba.
id	integer	Identificador del plan de prueba.
iteration	string	Ruta de acceso de iteración del plan de prueba.
name	string	Nombre del plan de prueba.
owner	IdentityRef	Propietario del plan de prueba.
previousBuild	ShallowReference	Referencia abstracta a algún otro recurso. Esta clase se usa para proporcionar los contratos de datos de compilación con una manera uniforme de hacer referencia a otros recursos de una manera que proporciona un recorrido fácil a través de vínculos.
project	ShallowReference	Proyecto que contiene el plan de prueba.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Entorno de versión que se usará para implementar la compilación y ejecutar pruebas automatizadas a partir de este plan de prueba.
revision	integer	Revisión del plan de prueba.
rootSuite	ShallowReference	Conjunto de pruebas raíz del plan de pruebas.
startDate	string	Fecha de inicio del plan de prueba.
state	string	Estado del plan de prueba.
testOutcomeSettings	TestOutcomeSettings	Valor para configurar cómo deben comportarse las mismas pruebas en conjuntos de pruebas en un plan de pruebas
updatedBy	IdentityRef
updatedDate	string
url	string	Dirección URL del recurso del plan de prueba.

Test Plans - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Scopes

Ejemplos

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

Definiciones

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Comentarios

Recursos adicionales