Test Plans - Get

Referenz

Dienst:: Test

API-Version:: 5.0

Abrufen des Testplans nach ID.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
planId	path	True	integer int32	ID des zurückzugebenden Testplans.
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.

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	Ermöglicht das Lesen von Testplänen, Fällen, Ergebnissen und anderen Artefakten im Zusammenhang mit der Testverwaltung.

Beispiele

Beispielanforderung

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/1?api-version=5.0

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": 1,
  "name": "sprint1",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1",
  "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": "",
  "startDate": "2014-05-04T16:21:36.253Z",
  "endDate": "2014-05-11T16:21:36.253Z",
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
  "updatedDate": "2014-05-04T10:51:37.127Z",
  "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": "1",
    "name": "sprint1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=1"
}

Definitionen

Name	Beschreibung
IdentityRef
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 zum Verweisen auf andere Ressourcen bereitzustellen, die eine einfache Durchquerung von Links ermöglicht.
TestOutcomeSettings	Testergebniseinstellungen
TestPlan	Die Testplanressource.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff 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 Graph-Betreffs. 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.

ReferenceLinks

Objekt

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

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

ReleaseEnvironmentDefinitionReference

Objekt

Verweis auf die Releaseumgebungsressource.

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

ShallowReference

Objekt

Ein abstrahierter Verweis auf eine andere Ressource. Diese Klasse wird verwendet, um die Builddatenverträge mit einer einheitlichen Möglichkeit zum Verweisen auf andere Ressourcen bereitzustellen, 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

Objekt

Testergebniseinstellungen

Name	Typ	Beschreibung
syncOutcomeAcrossSuites	boolean	Wert zum Konfigurieren, wie testergebnisse für die gleichen Tests in verschiedenen Suites angezeigt werden

TestPlan

Objekt

Die Testplanressource.

Name	Typ	Beschreibung
area	ShallowReference	Bereich des Testplans.
build	ShallowReference	Zu testende Build.
buildDefinition	ShallowReference	Die Builddefinition, die einen Build generiert, der diesem Testplan zugeordnet ist.
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 zum Verweisen auf andere Ressourcen bereitzustellen, die eine einfache Durchquerung von Links ermöglicht.
project	ShallowReference	Projekt, das den Testplan enthält.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Releaseumgebung, die verwendet werden soll, um den Build bereitzustellen und automatisierte Tests aus diesem Testplan auszuführen.
revision	integer	Revision des Testplans.
rootSuite	ShallowReference	Stammtestsammlung 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 - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

IdentityRef

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan