Test Plans - Create

Referenz

Dienst:: Test Plan

API-Version:: 7.1

Erstellen Sie einen Testplan.

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

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 "7.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
areaPath	string	Bereich des Testplans.
buildDefinition	BuildDefinitionReference	Die Builddefinition, die einen Build generiert, der diesem Testplan zugeordnet ist.
buildId	integer (int32)	Zu testende Build.
description	string	Beschreibung des Testplans.
endDate	string (date-time)	Enddatum für den Testplan.
iteration	string	Iterationspfad des Testplans.
name	string	Name des Testplans.
owner	IdentityRef	Besitzer des Testplans.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release-Umgebung, die verwendet werden soll, um den Build bereitzustellen und automatisierte Tests aus diesem Testplan auszuführen.
startDate	string (date-time)	Startdatum für den Testplan.
state	string	Status des Testplans.
testOutcomeSettings	TestOutcomeSettings	Wert, um zu konfigurieren, wie sich dieselben Tests in Testsuiten unter einem Testplan verhalten müssen

Antworten

Name	Typ	Beschreibung
200 OK	TestPlan	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.test_write	Gewährt die Möglichkeit, Testpläne, Fälle, Ergebnisse und andere artefaktbezogene Testverwaltung zu lesen, zu erstellen und zu aktualisieren.

Beispiele

Create a test plan with all details.

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

Create a test plan with all details.

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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.

Beispielanforderung

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
}

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
BuildDefinitionReference	Die Builddefinitionsreferenzressource
IdentityRef
ProjectState	Projektstatus.
ProjectVisibility	Projektsichtbarkeit.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
ReleaseEnvironmentDefinitionReference	Verweis auf die Freigabeumgebungsressource.
TeamProjectReference	Stellt einen flachen Verweis auf ein TeamProject dar.
TestOutcomeSettings	Testen der Ergebniseinstellungen
TestPlan	Die Testplanressource.
TestPlanCreateParams	Der Testplan erstellt Parameter.
TestSuiteReference	Die Referenzressource der Testsuite.

BuildDefinitionReference

Objekt

Die Builddefinitionsreferenzressource

Name	Typ	Beschreibung
id	integer (int32)	ID der Builddefinition
name	string	Name der Builddefinition

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ProjectState

Enumeration

Projektstatus.

Wert	Beschreibung
all	Alle Projekte unabhängig vom Status außer "Gelöscht".
createPending	Projekt wurde zur Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet.
deleted	Projekt wurde gelöscht.
deleting	Project wird gerade gelöscht.
new	Projekt wird gerade erstellt.
unchanged	Projekt wurde nicht geändert.
wellFormed	Project wird vollständig erstellt und kann verwendet werden.

ProjectVisibility

Enumeration

Projektsichtbarkeit.

Wert	Beschreibung
private	Das Projekt ist nur für Benutzer mit expliziten Zugriff sichtbar.
public	Das Projekt ist für alle sichtbar.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

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

ReleaseEnvironmentDefinitionReference

Objekt

Verweis auf die Freigabeumgebungsressource.

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

TeamProjectReference

Objekt

Stellt einen flachen Verweis auf ein TeamProject dar.

Name	Typ	Beschreibung
abbreviation	string	Projektkürzel.
defaultTeamImageUrl	string	Url zum standardmäßigen Teamidentitätsbild.
description	string	Die Beschreibung des Projekts (falls vorhanden).
id	string (uuid)	Projektbezeichner.
lastUpdateTime	string (date-time)	Zeitpunkt der letzten Aktualisierung des Projekts.
name	string	Projektname.
revision	integer (int64)	Projektrevision.
state	ProjectState	Projektstatus.
url	string	Die URL zur Vollversion des Objekts.
visibility	ProjectVisibility	Projektsichtbarkeit.

TestOutcomeSettings

Objekt

Testen der Ergebniseinstellungen

Name	Typ	Beschreibung
syncOutcomeAcrossSuites	boolean	Wert, der konfiguriert, wie Testergebnisse für dieselben Tests in allen Suites angezeigt werden

TestPlan

Objekt

Die Testplanressource.

Name	Typ	Beschreibung
_links	ReferenceLinks	Relevante Links
areaPath	string	Bereich des Testplans.
buildDefinition	BuildDefinitionReference	Die Builddefinition, die einen Build generiert, der diesem Testplan zugeordnet ist.
buildId	integer (int32)	Zu testende Build.
description	string	Beschreibung des Testplans.
endDate	string (date-time)	Enddatum für den Testplan.
id	integer (int32)	ID des Testplans.
iteration	string	Iterationspfad des Testplans.
name	string	Name des Testplans.
owner	IdentityRef	Besitzer des Testplans.
previousBuildId	integer (int32)	Vorherige Build-ID, die dem Testplan zugeordnet ist
project	TeamProjectReference	Projekt, das den Testplan enthält.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release-Umgebung, die verwendet werden soll, um den Build bereitzustellen und automatisierte Tests aus diesem Testplan auszuführen.
revision	integer (int32)	Überarbeitung des Testplans.
rootSuite	TestSuiteReference	Stammtestsuite des Testplans.
startDate	string (date-time)	Startdatum für den Testplan.
state	string	Status des Testplans.
testOutcomeSettings	TestOutcomeSettings	Wert, um zu konfigurieren, wie sich dieselben Tests in Testsuiten unter einem Testplan verhalten müssen
updatedBy	IdentityRef	Identitätsreferenz für die letzte Aktualisierung des Testplans
updatedDate	string (date-time)	Aktualisierungsdatum des Testplans

TestPlanCreateParams

Objekt

Der Testplan erstellt Parameter.

Name	Typ	Beschreibung
areaPath	string	Bereich des Testplans.
buildDefinition	BuildDefinitionReference	Die Builddefinition, die einen Build generiert, der diesem Testplan zugeordnet ist.
buildId	integer (int32)	Zu testende Build.
description	string	Beschreibung des Testplans.
endDate	string (date-time)	Enddatum für den Testplan.
iteration	string	Iterationspfad des Testplans.
name	string	Name des Testplans.
owner	IdentityRef	Besitzer des Testplans.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Release-Umgebung, die verwendet werden soll, um den Build bereitzustellen und automatisierte Tests aus diesem Testplan auszuführen.
startDate	string (date-time)	Startdatum für den Testplan.
state	string	Status des Testplans.
testOutcomeSettings	TestOutcomeSettings	Wert, um zu konfigurieren, wie sich dieselben Tests in Testsuiten unter einem Testplan verhalten müssen

TestSuiteReference

Objekt

Die Referenzressource der Testsuite.

Name	Typ	Beschreibung
id	integer (int32)	ID der Testsuite.
name	string	Name der Testsuite.

Freigeben über

Test Plans - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Create a test plan with all details.

Beispielanforderung

Beispiel für eine Antwort

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

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference