Test Plans - Create

Référence

Service:: Test

API Version:: 5.0

Créez un plan de test.

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

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 « 5.0 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
area	ShallowReference	Chemin d’accès à la zone auquel appartient le plan de test. Cela doit être défini sur le chemin de zone de l’équipe qui travaille sur ce plan de test.
build	ShallowReference	ID de build de la build dont la qualité est testée par les tests de ce plan de test. Pour les tests automatisés, cet ID de build est utilisé pour rechercher les fichiers binaires de test qui contiennent des méthodes de test automatisées.
buildDefinition	ShallowReference	Définition de build qui génère une build associée à ce plan de test.
configurationIds	integer[]	ID de configurations à appliquer lorsque de nouvelles suites de tests et cas de test sont ajoutés au plan de test.
description	string	Description du plan de test.
endDate	string	Date de fin du plan de test.
iteration	string	Chemin d’itération affecté au plan de test. Cela indique quand l’itération cible selon laquelle les tests de ce plan sont censés être terminés et que le produit est prêt à être publié.
name	string	Nom du plan de test.
owner	IdentityRef	Propriétaire du plan de test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment à utiliser pour déployer la génération et exécuter des tests automatisés à partir de ce plan de test.
startDate	string	Date de début du plan de test.
state	string	État du plan de test.
testOutcomeSettings	TestOutcomeSettings	Paramètres des résultats du test

Réponses

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

Sécurité

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

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

Exemples

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

Définitions

Nom	Description
IdentityRef
PlanUpdateModel	Classe de modèle utilisée pour créer et mettre à jour des plans de test.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ReleaseEnvironmentDefinitionReference	Référence à la ressource d’environnement de mise en production.
ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources d’une manière qui permet de parcourir facilement les liens.
TestOutcomeSettings	Paramètres des résultats du test
TestPlan	Ressource de plan de test.

IdentityRef

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 graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations.
directoryAlias	string
displayName	string	Il s’agit du nom d’affichage non unique du sujet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

PlanUpdateModel

Classe de modèle utilisée pour créer et mettre à jour des plans de test.

Nom	Type	Description
area	ShallowReference	Chemin d’accès à la zone auquel appartient le plan de test. Cela doit être défini sur le chemin de zone de l’équipe qui travaille sur ce plan de test.
build	ShallowReference	ID de build de la build dont la qualité est testée par les tests de ce plan de test. Pour les tests automatisés, cet ID de build est utilisé pour rechercher les fichiers binaires de test qui contiennent des méthodes de test automatisées.
buildDefinition	ShallowReference	Définition de build qui génère une build associée à ce plan de test.
configurationIds	integer[]	ID de configurations à appliquer lorsque de nouvelles suites de tests et cas de test sont ajoutés au plan de test.
description	string	Description du plan de test.
endDate	string	Date de fin du plan de test.
iteration	string	Chemin d’itération affecté au plan de test. Cela indique quand l’itération cible selon laquelle les tests de ce plan sont censés être terminés et que le produit est prêt à être publié.
name	string	Nom du plan de test.
owner	IdentityRef	Propriétaire du plan de test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment à utiliser pour déployer la génération et exécuter des tests automatisés à partir de ce plan de test.
startDate	string	Date de début du plan de test.
state	string	État du plan de test.
testOutcomeSettings	TestOutcomeSettings	Paramètres des résultats du test

ReferenceLinks

Classe pour 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

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

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

ShallowReference

Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources d’une manière qui permet de parcourir facilement les liens.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource liée (nom de la définition, nom du contrôleur, etc.)
url	string	Lien http complet vers la ressource

TestOutcomeSettings

Paramètres des résultats du 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

Ressource de plan de test.

Nom	Type	Description
area	ShallowReference	Zone du plan de test.
build	ShallowReference	Build à tester.
buildDefinition	ShallowReference	Définition de build qui génère une build associée à ce plan de test.
description	string	Description du plan de test.
endDate	string	Date de fin du plan de test.
id	integer	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.
previousBuild	ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources d’une manière qui permet de parcourir facilement les liens.
project	ShallowReference	Projet qui contient le plan de test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release Environment à utiliser pour déployer la génération et exécuter des tests automatisés à partir de ce plan de test.
revision	integer	Révision du plan de test.
rootSuite	ShallowReference	Suite de tests racine du plan de test.
startDate	string	Date de début du plan de test.
state	string	État du plan de test.
testOutcomeSettings	TestOutcomeSettings	Valeur pour configurer le comportement des mêmes tests entre les suites de tests dans le cadre d’un plan de test
updatedBy	IdentityRef
updatedDate	string
url	string	URL de la ressource de plan de test.

Partager via

Test Plans - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Scopes

Exemples

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

Définitions

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Ressources supplémentaires