Test Plans - Create

Riferimento

Service:: Test

API Version:: 5.0

Creare un piano di test.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '5.0' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
area	ShallowReference	Percorso dell'area a cui appartiene il piano di test. Deve essere impostato sul percorso dell'area del team che lavora su questo piano di test.
build	ShallowReference	ID di compilazione della compilazione la cui qualità viene testata dai test in questo piano di test. Per i test automatizzati, questo ID di compilazione viene usato per trovare i file binari di test che contengono metodi di test automatizzati.
buildDefinition	ShallowReference	Definizione di compilazione che genera una compilazione associata a questo piano di test.
configurationIds	integer[]	ID delle configurazioni da applicare quando vengono aggiunti nuovi gruppi di test e test case al piano di test.
description	string	Descrizione del piano di test.
endDate	string	Data di fine per il piano di test.
iteration	string	Percorso di iterazione assegnato al piano di test. Indica quando l'iterazione di destinazione in base alla quale il test in questo piano deve essere completato e il prodotto è pronto per il rilascio.
name	string	Nome del piano di test.
owner	IdentityRef	Proprietario del piano di test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Ambiente di rilascio da usare per distribuire la compilazione ed eseguire test automatizzati da questo piano di test.
startDate	string	Data di inizio per il piano di test.
state	string	Stato del piano di test.
testOutcomeSettings	TestOutcomeSettings	Impostazioni del risultato del test

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_write	Concede la possibilità di leggere, creare e aggiornare piani di test, case, risultati e altri artefatti correlati alla gestione dei test.

Esempio

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

Definizioni

Nome	Descrizione
IdentityRef
PlanUpdateModel	Classe di modello usata per la creazione e l'aggiornamento dei piani di test.
ReferenceLinks	Classe per 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 da semplificare l'attraversamento dei 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 del grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo oggetto grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso oggetto grafico in account e organizzazioni.
directoryAlias	string
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore 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.

PlanUpdateModel

Classe di modello usata per la creazione e l'aggiornamento dei piani di test.

Nome	Tipo	Descrizione
area	ShallowReference	Percorso dell'area a cui appartiene il piano di test. Deve essere impostato sul percorso dell'area del team che lavora su questo piano di test.
build	ShallowReference	ID di compilazione della compilazione la cui qualità viene testata dai test in questo piano di test. Per i test automatizzati, questo ID di compilazione viene usato per trovare i file binari di test che contengono metodi di test automatizzati.
buildDefinition	ShallowReference	Definizione di compilazione che genera una compilazione associata a questo piano di test.
configurationIds	integer[]	ID delle configurazioni da applicare quando vengono aggiunti nuovi gruppi di test e test case al piano di test.
description	string	Descrizione del piano di test.
endDate	string	Data di fine per il piano di test.
iteration	string	Percorso di iterazione assegnato al piano di test. Indica quando l'iterazione di destinazione in base alla quale il test in questo piano deve essere completato e il prodotto è pronto per il rilascio.
name	string	Nome del piano di test.
owner	IdentityRef	Proprietario del piano di test.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Ambiente di rilascio da usare per distribuire la compilazione ed eseguire test automatizzati da questo piano di test.
startDate	string	Data di inizio per il piano di test.
state	string	Stato del piano di test.
testOutcomeSettings	TestOutcomeSettings	Impostazioni del risultato del test

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

ReleaseEnvironmentDefinitionReference

Riferimento alla risorsa dell'ambiente di rilascio.

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

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 da semplificare l'attraversamento dei 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 la modalità di visualizzazione dei risultati dei test per gli stessi test tra gruppi

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 da semplificare l'attraversamento dei collegamenti.
project	ShallowReference	Progetto che contiene 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	Gruppo 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 tra gruppi di test in un piano di test
updatedBy	IdentityRef
updatedDate	string
url	string	URL della risorsa del piano di test.

Test Plans - Create

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Scopes

Esempio

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

Definizioni

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Commenti e suggerimenti

Risorse aggiuntive