Test Plans - Create

Référence

Service:: Test Plan

Version d'API:: 7.1

Créez un plan de test.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
areaPath	string	Zone du plan de test.
buildDefinition	BuildDefinitionReference	Définition de build qui génère une build associée à ce plan de test.
buildId	integer (int32)	Build à tester.
description	string	Description du plan de test.
endDate	string (date-time)	Date de fin du plan de test.
iteration	string	Chemin d’itération du plan de test.
name	string	Nom du plan de test.
owner	IdentityRef	Propriétaire du plan de test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Environnement de mise en production à utiliser pour déployer la build et exécuter des tests automatisés à partir de ce plan de test.
startDate	string (date-time)	Date de début du plan de test.
state	string	État du plan de test.
testOutcomeSettings	TestOutcomeSettings	Valeur pour configurer la façon dont les mêmes tests dans les suites de tests sous un plan de test doivent se comporter

Réponses

Nom	Type	Description
200 OK	TestPlan	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom	Description
vso.test_write	Accorde la possibilité de lire, de créer et de mettre à jour des plans de test, des cas, des résultats et d’autres artefacts associés à la gestion des tests.

Exemples

Create a test plan with all details.

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

Create a test plan with all details.

Exemple de requête

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

Exemple de réponse

Code d’état:: 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.

Exemple de requête

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
}

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
BuildDefinitionReference	Ressource de référence de définition de build
IdentityRef
ProjectState	État du projet.
ProjectVisibility	Visibilité du projet.
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
ReleaseEnvironmentDefinitionReference	Référence à la ressource d’environnement de mise en production.
TeamProjectReference	Représente une référence superficielle à un TeamProject.
TestOutcomeSettings	Paramètres de résultat de test
TestPlan	Ressource de plan de test.
TestPlanCreateParams	Le plan de test crée des paramètres.
TestSuiteReference	Ressource de référence de la suite de tests.

BuildDefinitionReference

Object

Ressource de référence de définition de build

Nom	Type	Description
id	integer (int32)	ID de la définition de build
name	string	Nom de la définition de build

IdentityRef

Object

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom complet non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déconseillé - Disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utiliser Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.

ProjectState

Énumération

État du projet.

Valeur	Description
all	Tous les projets, quel que soit l’état, sauf supprimé.
createPending	Project a été mis en file d’attente pour la création, mais le processus n’a pas encore démarré.
deleted	Le projet a été supprimé.
deleting	Le projet est en cours de suppression.
new	Le projet est en cours de création.
unchanged	Le projet n’a pas été modifié.
wellFormed	Le projet est entièrement créé et prêt à être utilisé.

ProjectVisibility

Énumération

Visibilité du projet.

Valeur	Description
private	Le projet n’est visible que par les utilisateurs disposant d’un accès explicite.
public	Le projet est visible pour tous.

ReferenceLinks

Object

Classe à représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ReleaseEnvironmentDefinitionReference

Object

Référence à la ressource d’environnement de mise en production.

Nom	Type	Description
definitionId	integer (int32)	ID de la définition de mise en production qui contient la définition de l’environnement de mise en production.
environmentDefinitionId	integer (int32)	ID de la définition de l’environnement de mise en production.

TeamProjectReference

Object

Représente une référence superficielle à un TeamProject.

Nom	Type	Description
abbreviation	string	Abréviation du projet.
defaultTeamImageUrl	string	URL de l’image d’identité d’équipe par défaut.
description	string	Description du projet (le cas échéant).
id	string (uuid)	Identificateur du projet.
lastUpdateTime	string (date-time)	Heure de la dernière mise à jour du projet.
name	string	Nom du projet.
revision	integer (int64)	Révision du projet.
state	ProjectState	État du projet.
url	string	URL vers la version complète de l’objet.
visibility	ProjectVisibility	Visibilité du projet.

TestOutcomeSettings

Object

Paramètres de résultat de test

Nom	Type	Description
syncOutcomeAcrossSuites	boolean	Valeur pour configurer la façon dont les résultats des tests pour les mêmes tests entre les suites sont affichés

TestPlan

Object

Ressource de plan de test.

Nom	Type	Description
_links	ReferenceLinks	Liens pertinents
areaPath	string	Zone du plan de test.
buildDefinition	BuildDefinitionReference	Définition de build qui génère une build associée à ce plan de test.
buildId	integer (int32)	Build à tester.
description	string	Description du plan de test.
endDate	string (date-time)	Date de fin du plan de test.
id	integer (int32)	ID du plan de test.
iteration	string	Chemin d’itération du plan de test.
name	string	Nom du plan de test.
owner	IdentityRef	Propriétaire du plan de test.
previousBuildId	integer (int32)	ID de build précédent associé au plan de test
project	TeamProjectReference	Projet qui contient le plan de test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Environnement de mise en production à utiliser pour déployer la build et exécuter des tests automatisés à partir de ce plan de test.
revision	integer (int32)	Révision du plan de test.
rootSuite	TestSuiteReference	Suite de tests racines du plan de test.
startDate	string (date-time)	Date de début du plan de test.
state	string	État du plan de test.
testOutcomeSettings	TestOutcomeSettings	Valeur pour configurer la façon dont les mêmes tests dans les suites de tests sous un plan de test doivent se comporter
updatedBy	IdentityRef	Référence d’identité pour la dernière mise à jour du plan de test
updatedDate	string (date-time)	Date de mise à jour du plan de test

TestPlanCreateParams

Object

Le plan de test crée des paramètres.

Nom	Type	Description
areaPath	string	Zone du plan de test.
buildDefinition	BuildDefinitionReference	Définition de build qui génère une build associée à ce plan de test.
buildId	integer (int32)	Build à tester.
description	string	Description du plan de test.
endDate	string (date-time)	Date de fin du plan de test.
iteration	string	Chemin d’itération du plan de test.
name	string	Nom du plan de test.
owner	IdentityRef	Propriétaire du plan de test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Environnement de mise en production à utiliser pour déployer la build et exécuter des tests automatisés à partir de ce plan de test.
startDate	string (date-time)	Date de début du plan de test.
state	string	État du plan de test.
testOutcomeSettings	TestOutcomeSettings	Valeur pour configurer la façon dont les mêmes tests dans les suites de tests sous un plan de test doivent se comporter

TestSuiteReference

Object

Ressource de référence de la suite de tests.

Nom	Type	Description
id	integer (int32)	ID de la suite de tests.
name	string	Nom de la suite de tests.

Partager via

Test Plans - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Étendues

Exemples

Create a test plan with all details.

Exemple de requête

Exemple de réponse

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

Exemple de requête

Exemple de réponse

Définitions

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference