Test Plans - Update
Aggiornare un piano di test.
PATCH 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. |
plan
|
path | True |
integer int32 |
ID del piano di test da aggiornare. |
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. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
area |
Percorso dell'area a cui appartiene il piano di test. Questa opzione deve essere impostata sul percorso dell'area del team che lavora su questo piano di test. |
|
build |
ID 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 |
Definizione di compilazione che genera una compilazione associata a questo piano di test. |
|
configurationIds |
integer[] |
ID delle configurazioni da applicare quando vengono aggiunti nuovi test suite 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. Questo indica quando l'iterazione di destinazione in base alla quale il test in questo piano deve essere completato e il prodotto è pronto per essere rilasciato. |
name |
string |
Nome del piano di test. |
owner |
Proprietario del piano di test. |
|
releaseEnvironmentDefinition |
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 |
Impostazioni dei risultati dei test |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
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
Update area and iteration of a test plan. |
Update name and description of a test plan. |
Update name of a test plan. |
Update state of a test plan. |
Update area and iteration of a test plan.
Sample Request
PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/17?api-version=5.0
{
"area": {
"name": "Fabrikam-Fiber-TFVC\\Quality assurance"
},
"iteration": "Fabrikam-Fiber-TFVC\\Release 1"
}
Sample Response
{
"id": 17,
"name": "newCreatedPlan2",
"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": "411",
"name": "Fabrikam-Fiber-TFVC\\Quality assurance"
},
"description": "Our new plan",
"startDate": "2014-05-01T00:00:00Z",
"endDate": "2014-05-10T00:00:00Z",
"iteration": "Fabrikam-Fiber-TFVC\\Release 1",
"updatedDate": "2014-05-06T13:43:09.787Z",
"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": 3,
"state": "Active",
"rootSuite": {
"id": "34",
"name": "newCreatedPlan2",
"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"
}
Update name and description of a test plan.
Sample Request
PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/17?api-version=5.0
{
"name": "newCreatedPlan2",
"description": "Our new plan"
}
Sample Response
{
"id": 17,
"name": "newCreatedPlan2",
"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"
},
"description": "Our new plan",
"startDate": "2014-05-01T00:00:00Z",
"endDate": "2014-05-10T00:00:00Z",
"iteration": "Fabrikam-Fiber-TFVC",
"updatedDate": "2014-05-06T13:43:07.247Z",
"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": 2,
"state": "Active",
"rootSuite": {
"id": "34",
"name": "newCreatedPlan2",
"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"
}
Update name of a test plan.
Sample Request
PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/218?api-version=5.0
{
"name": "newCreatedPlan2"
}
Sample Response
{
"id": 218,
"name": "newCreatedPlan2",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/218",
"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-10-07T22:18:49.7Z",
"endDate": "2014-10-14T22:18:49.7Z",
"iteration": "Fabrikam-Fiber-TFVC",
"updatedDate": "2014-10-07T22:18:50.333Z",
"updatedBy": {
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"displayName": "Chuck Reinhart",
"uniqueName": "fabrikamfiber3@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"owner": {
"id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"displayName": "Chuck Reinhart",
"uniqueName": "fabrikamfiber3@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
},
"revision": 2,
"state": "Active",
"rootSuite": {
"id": "219",
"name": "newCreatedPlan2",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/218/Suites/219"
},
"clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=218"
}
Update state of a test plan.
Sample Request
PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/17?api-version=5.0
{
"state": "Inactive"
}
Sample Response
{
"id": 17,
"name": "newCreatedPlan2",
"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": "411",
"name": "Fabrikam-Fiber-TFVC\\Quality assurance"
},
"description": "Our new plan",
"startDate": "2014-05-01T00:00:00Z",
"endDate": "2014-05-10T00:00:00Z",
"iteration": "Fabrikam-Fiber-TFVC\\Release 1",
"updatedDate": "2014-05-06T13:43:13.17Z",
"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": 4,
"state": "Inactive",
"rootSuite": {
"id": "34",
"name": "newCreatedPlan2",
"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 |
---|---|
Identity |
|
Plan |
Classe modello usata per la creazione e l'aggiornamento dei piani di test. |
Reference |
Classe da rappresentare una raccolta di collegamenti di riferimento REST. |
Release |
Riferimento alla risorsa dell'ambiente di rilascio. |
Shallow |
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. |
Test |
Impostazioni dei risultati dei test |
Test |
Risorsa del piano di test. |
IdentityRef
Nome | Tipo | Descrizione |
---|---|---|
_links |
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. |
PlanUpdateModel
Classe modello usata per la creazione e l'aggiornamento dei piani di test.
Nome | Tipo | Descrizione |
---|---|---|
area |
Percorso dell'area a cui appartiene il piano di test. Questa opzione deve essere impostata sul percorso dell'area del team che lavora su questo piano di test. |
|
build |
ID 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 |
Definizione di compilazione che genera una compilazione associata a questo piano di test. |
|
configurationIds |
integer[] |
ID delle configurazioni da applicare quando vengono aggiunti nuovi test suite 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. Questo indica quando l'iterazione di destinazione in base alla quale il test in questo piano deve essere completato e il prodotto è pronto per essere rilasciato. |
name |
string |
Nome del piano di test. |
owner |
Proprietario del piano di test. |
|
releaseEnvironmentDefinition |
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 |
Impostazioni dei risultati dei test |
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 |
Area del piano di test. |
|
build |
Compilazione da testare. |
|
buildDefinition |
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 |
Proprietario del piano di test. |
|
previousBuild |
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 |
Progetto contenente il piano di test. |
|
releaseEnvironmentDefinition |
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 |
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 |
Valore per configurare il comportamento degli stessi test nei gruppi di test in un piano di test |
|
updatedBy | ||
updatedDate |
string |
|
url |
string |
URL della risorsa del piano di test. |
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per