Test Plans - Create

Referenz

Service:: Test

API Version:: 5.0

Erstellen Sie einen Testplan.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "5.0" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
area	ShallowReference	Bereichspfad, zu dem der Testplan gehört. Dies sollte auf den Bereichspfad des Teams festgelegt werden, das an diesem Testplan arbeitet.
build	ShallowReference	Build-ID des Builds, dessen Qualität durch die Tests in diesem Testplan getestet wird. Für automatisierte Tests wird diese Build-ID verwendet, um die Testbinärdateien zu finden, die automatisierte Testmethoden enthalten.
buildDefinition	ShallowReference	Die Builddefinition, die einen diesem Testplan zugeordneten Build generiert.
configurationIds	integer[]	IDs von Konfigurationen, die angewendet werden sollen, wenn dem Testplan neue Testsammlungen und Testfälle hinzugefügt werden.
description	string	Beschreibung des Testplans.
endDate	string	Enddatum für den Testplan.
iteration	string	Iterationspfad, der dem Testplan zugewiesen ist. Dies gibt an, wann die Zieliteration, mit der die Tests in diesem Plan abgeschlossen sein sollen, und das Produkt bereit für die Veröffentlichung ist.
name	string	Name des Testplans.
owner	IdentityRef	Besitzer des Testplans.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Releaseumgebung, die zum Bereitstellen des Builds und Ausführen automatisierter Tests aus diesem Testplan verwendet werden soll.
startDate	string	Startdatum für den Testplan.
state	string	Status des Testplans.
testOutcomeSettings	TestOutcomeSettings	Testergebniseinstellungen

Antworten

Name	Typ	Beschreibung
200 OK	TestPlan	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.test_write	Ermöglicht das Lesen, Erstellen und Aktualisieren von Testplänen, Fällen, Ergebnissen und anderen Artefakten im Zusammenhang mit der Testverwaltung.

Beispiele

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

Definitionen

Name	Beschreibung
IdentityRef
PlanUpdateModel	Eine Modellklasse, die zum Erstellen und Aktualisieren von Testplänen verwendet wird.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
ReleaseEnvironmentDefinitionReference	Verweis auf die Releaseumgebungsressource.
ShallowReference	Ein abstrahierter Verweis auf eine andere Ressource. Diese Klasse wird verwendet, um die Builddatenverträge mit einer einheitlichen Möglichkeit bereitzustellen, andere Ressourcen auf eine Weise zu verweisen, die eine einfache Durchquerung von Links ermöglicht.
TestOutcomeSettings	Testergebniseinstellungen
TestPlan	Die Testplanressource.

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

PlanUpdateModel

Eine Modellklasse, die zum Erstellen und Aktualisieren von Testplänen verwendet wird.

Name	Typ	Beschreibung
area	ShallowReference	Bereichspfad, zu dem der Testplan gehört. Dies sollte auf den Bereichspfad des Teams festgelegt werden, das an diesem Testplan arbeitet.
build	ShallowReference	Build-ID des Builds, dessen Qualität durch die Tests in diesem Testplan getestet wird. Für automatisierte Tests wird diese Build-ID verwendet, um die Testbinärdateien zu finden, die automatisierte Testmethoden enthalten.
buildDefinition	ShallowReference	Die Builddefinition, die einen diesem Testplan zugeordneten Build generiert.
configurationIds	integer[]	IDs von Konfigurationen, die angewendet werden sollen, wenn dem Testplan neue Testsammlungen und Testfälle hinzugefügt werden.
description	string	Beschreibung des Testplans.
endDate	string	Enddatum für den Testplan.
iteration	string	Iterationspfad, der dem Testplan zugewiesen ist. Dies gibt an, wann die Zieliteration, mit der die Tests in diesem Plan abgeschlossen sein sollen, und das Produkt bereit für die Veröffentlichung ist.
name	string	Name des Testplans.
owner	IdentityRef	Besitzer des Testplans.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Releaseumgebung, die zum Bereitstellen des Builds und Ausführen automatisierter Tests aus diesem Testplan verwendet werden soll.
startDate	string	Startdatum für den Testplan.
state	string	Status des Testplans.
testOutcomeSettings	TestOutcomeSettings	Testergebniseinstellungen

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

ReleaseEnvironmentDefinitionReference

Verweis auf die Releaseumgebungsressource.

Name	Typ	Beschreibung
definitionId	integer	ID der Releasedefinition, die die Releaseumgebungsdefinition enthält.
environmentDefinitionId	integer	ID der Releaseumgebungsdefinition.

ShallowReference

Ein abstrahierter Verweis auf eine andere Ressource. Diese Klasse wird verwendet, um die Builddatenverträge mit einer einheitlichen Möglichkeit bereitzustellen, andere Ressourcen auf eine Weise zu verweisen, die eine einfache Durchquerung von Links ermöglicht.

Name	Typ	Beschreibung
id	string	ID der Ressource
name	string	Name der verknüpften Ressource (Definitionsname, Controllername usw.)
url	string	Vollständiger HTTP-Link zur Ressource

TestOutcomeSettings

Testergebniseinstellungen

Name	Typ	Beschreibung
syncOutcomeAcrossSuites	boolean	Wert zum Konfigurieren der Darstellung von Testergebnissen für dieselben Tests in verschiedenen Suiten

TestPlan

Die Testplanressource.

Name	Typ	Beschreibung
area	ShallowReference	Bereich des Testplans.
build	ShallowReference	Zu testende Build.
buildDefinition	ShallowReference	Die Builddefinition, die einen diesem Testplan zugeordneten Build generiert.
description	string	Beschreibung des Testplans.
endDate	string	Enddatum für den Testplan.
id	integer	ID des Testplans.
iteration	string	Iterationspfad des Testplans.
name	string	Name des Testplans.
owner	IdentityRef	Besitzer des Testplans.
previousBuild	ShallowReference	Ein abstrahierter Verweis auf eine andere Ressource. Diese Klasse wird verwendet, um die Builddatenverträge mit einer einheitlichen Möglichkeit bereitzustellen, andere Ressourcen auf eine Weise zu verweisen, die eine einfache Durchquerung von Links ermöglicht.
project	ShallowReference	Projekt, das den Testplan enthält.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Releaseumgebung, die zum Bereitstellen des Builds und Ausführen automatisierter Tests aus diesem Testplan verwendet werden soll.
revision	integer	Revision des Testplans.
rootSuite	ShallowReference	Stammtestsuite des Testplans.
startDate	string	Startdatum für den Testplan.
state	string	Status des Testplans.
testOutcomeSettings	TestOutcomeSettings	Wert zum Konfigurieren, wie sich dieselben Tests in Testsammlungen unter einem Testplan verhalten müssen
updatedBy	IdentityRef
updatedDate	string
url	string	URL der Testplanressource.

Freigeben über

Test Plans - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Scopes

Beispiele

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

Definitionen

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Feedback

Zusätzliche Ressourcen