Test Plans - Get

Riferimento

Service:: Test

API Version:: 5.0

Ottenere il piano di test in base all'ID.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
planId	path	True	integer int32	ID del piano di test da restituire.
project	path	True	string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '5.0' per usare questa versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	TestPlan	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.test	Concede la possibilità di leggere piani di test, case, risultati e altri artefatti correlati alla gestione dei test.

Esempio

Sample Request

HTTP

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

Sample Response

Status code:: 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"
}

Definizioni

Nome	Descrizione
IdentityRef
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
ReleaseEnvironmentDefinitionReference	Riferimento alla risorsa dell'ambiente di rilascio.
ShallowReference	Riferimento astratto ad altre risorse. Questa classe viene usata per fornire ai contratti dati di compilazione un modo uniforme per fare riferimento ad altre risorse in modo che fornisca un facile attraversamento attraverso i collegamenti.
TestOutcomeSettings	Impostazioni dei risultati dei test
TestPlan	Risorsa del piano di test.

IdentityRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.
directoryAlias	string
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

ReleaseEnvironmentDefinitionReference

Riferimento alla risorsa dell'ambiente di rilascio.

Nome	Tipo	Descrizione
definitionId	integer	ID della definizione di versione contenente la definizione dell'ambiente di rilascio.
environmentDefinitionId	integer	ID della definizione dell'ambiente di rilascio.

ShallowReference

Riferimento astratto ad altre risorse. Questa classe viene usata per fornire ai contratti dati di compilazione un modo uniforme per fare riferimento ad altre risorse in modo che fornisca un facile attraversamento attraverso i collegamenti.

Nome	Tipo	Descrizione
id	string	ID della risorsa
name	string	Nome della risorsa collegata (nome della definizione, nome del controller e così via)
url	string	Collegamento http completo alla risorsa

TestOutcomeSettings

Impostazioni dei risultati dei test

Nome	Tipo	Descrizione
syncOutcomeAcrossSuites	boolean	Valore per configurare il modo in cui vengono visualizzati i risultati dei test per gli stessi test tra i pacchetti

TestPlan

Risorsa del piano di test.

Nome	Tipo	Descrizione
area	ShallowReference	Area del piano di test.
build	ShallowReference	Compilazione da testare.
buildDefinition	ShallowReference	Definizione di compilazione che genera una compilazione associata a questo piano di test.
description	string	Descrizione del piano di test.
endDate	string	Data di fine per il piano di test.
id	integer	ID del piano di test.
iteration	string	Percorso di iterazione del piano di test.
name	string	Nome del piano di test.
owner	IdentityRef	Proprietario del piano di test.
previousBuild	ShallowReference	Riferimento astratto ad altre risorse. Questa classe viene usata per fornire ai contratti dati di compilazione un modo uniforme per fare riferimento ad altre risorse in modo che fornisca un facile attraversamento attraverso i collegamenti.
project	ShallowReference	Progetto contenente il piano di test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Ambiente di rilascio da usare per distribuire la compilazione ed eseguire test automatizzati da questo piano di test.
revision	integer	Revisione del piano di test.
rootSuite	ShallowReference	Suite di test radice del piano di test.
startDate	string	Data di inizio per il piano di test.
state	string	Stato del piano di test.
testOutcomeSettings	TestOutcomeSettings	Valore per configurare il comportamento degli stessi test nei gruppi di test in un piano di test
updatedBy	IdentityRef
updatedDate	string
url	string	URL della risorsa del piano di test.