Test Plans - Create

Referencia

Servicio:: Test Plan

Versión de la API:: 7.1

Cree un plan de prueba.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	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 "7.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
areaPath	string	Área del plan de prueba.
buildDefinition	BuildDefinitionReference	Definición de compilación que genera una compilación asociada a este plan de prueba.
buildId	integer (int32)	Compilación que se va a probar.
description	string	Descripción del plan de prueba.
endDate	string (date-time)	Fecha de finalización 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.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Entorno de versión que se usará para implementar la compilación y ejecutar pruebas automatizadas desde este plan de prueba.
startDate	string (date-time)	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 entre conjuntos de pruebas en un plan de prueba

Respuestas

Nombre	Tipo	Description
200 OK	TestPlan	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del 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

Ámbitos

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

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

Create a test plan with all details.

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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.

Solicitud de ejemplo

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
}

Respuesta de muestra

status code:: 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
  }
}

Definiciones

Nombre	Description
BuildDefinitionReference	Recurso de referencia de definición de compilación
IdentityRef
ProjectState	Estado del proyecto.
ProjectVisibility	Visibilidad del proyecto.
ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
ReleaseEnvironmentDefinitionReference	Referencia al recurso del entorno de versión.
TeamProjectReference	Representa una referencia superficial a un TeamProject.
TestOutcomeSettings	Configuración del resultado de la prueba
TestPlan	Recurso del plan de prueba.
TestPlanCreateParams	El plan de prueba crea parámetros.
TestSuiteReference	Recurso de referencia del conjunto de pruebas.

BuildDefinitionReference

Object

Recurso de referencia de definición de compilación

Nombre	Tipo	Description
id	integer (int32)	Identificador de la definición de compilación
name	string	Nombre de la definición de compilación

IdentityRef

Object

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	En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links".
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	En desuso: disponible en la entrada "avatar" del diccionario "_links" identityRef
inactive	boolean	En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario "_links" de GraphUser.
isAadIdentity	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName	string	En desuso: use Domain+PrincipalName en su lugar.
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ProjectState

Enumeración

Estado del proyecto.

Valor	Description
all	Todos los proyectos, independientemente del estado, excepto Eliminado.
createPending	Project se ha puesto en cola para su creación, pero el proceso aún no se ha iniciado.
deleted	Se ha eliminado el proyecto.
deleting	Project está en proceso de eliminación.
new	Project está en proceso de creación.
unchanged	El proyecto no se ha cambiado.
wellFormed	Project se crea completamente y está listo para usarse.

ProjectVisibility

Enumeración

Visibilidad del proyecto.

Valor	Description
private	El proyecto solo es visible para los usuarios con acceso explícito.
public	El proyecto es visible para todos.

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

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

ReleaseEnvironmentDefinitionReference

Object

Referencia al recurso del entorno de versión.

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

TeamProjectReference

Object

Representa una referencia superficial a un TeamProject.

Nombre	Tipo	Description
abbreviation	string	Abreviatura del proyecto.
defaultTeamImageUrl	string	Dirección URL a la imagen de identidad del equipo predeterminada.
description	string	Descripción del proyecto (si existe).
id	string (uuid)	Identificador del proyecto.
lastUpdateTime	string (date-time)	Hora de última actualización del proyecto.
name	string	Nombre del proyecto.
revision	integer (int64)	Revisión del proyecto.
state	ProjectState	Estado del proyecto.
url	string	Dirección URL a la versión completa del objeto.
visibility	ProjectVisibility	Visibilidad del proyecto.

TestOutcomeSettings

Object

Configuración del resultado de la prueba

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

TestPlan

Object

Recurso del plan de prueba.

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos pertinentes
areaPath	string	Área del plan de prueba.
buildDefinition	BuildDefinitionReference	Definición de compilación que genera una compilación asociada a este plan de prueba.
buildId	integer (int32)	Compilación que se va a probar.
description	string	Descripción del plan de prueba.
endDate	string (date-time)	Fecha de finalización del plan de prueba.
id	integer (int32)	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.
previousBuildId	integer (int32)	Identificador de compilación anterior asociado al plan de prueba
project	TeamProjectReference	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 desde este plan de prueba.
revision	integer (int32)	Revisión del plan de prueba.
rootSuite	TestSuiteReference	Conjunto de pruebas raíz del plan de pruebas.
startDate	string (date-time)	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 entre conjuntos de pruebas en un plan de prueba
updatedBy	IdentityRef	Referencia de identidad para la última actualización del plan de prueba
updatedDate	string (date-time)	Fecha actualizada del plan de prueba

TestPlanCreateParams

Object

El plan de prueba crea parámetros.

Nombre	Tipo	Description
areaPath	string	Área del plan de prueba.
buildDefinition	BuildDefinitionReference	Definición de compilación que genera una compilación asociada a este plan de prueba.
buildId	integer (int32)	Compilación que se va a probar.
description	string	Descripción del plan de prueba.
endDate	string (date-time)	Fecha de finalización 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.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Entorno de versión que se usará para implementar la compilación y ejecutar pruebas automatizadas desde este plan de prueba.
startDate	string (date-time)	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 entre conjuntos de pruebas en un plan de prueba

TestSuiteReference

Object

Recurso de referencia del conjunto de pruebas.

Nombre	Tipo	Description
id	integer (int32)	Id. del conjunto de pruebas.
name	string	Nombre del conjunto de pruebas.

Compartir a través de

Test Plans - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Create a test plan with all details.

Solicitud de ejemplo

Respuesta de muestra

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

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference