Test Suites - Create

Riferimento

Service:: Test

API Version:: 5.0

Creare una suite di test.

POST https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/suites/{suiteId}?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 contenente la suite.
project	path	True	string	ID progetto o nome progetto
suiteId	path	True	integer int32	ID della suite padre.
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
name	string	Nome della suite di test.
queryString	string	Per le suite basate su query, la stringa di query che definisce la suite.
requirementIds	integer[]	Per i pacchetti di test dei requisiti, gli ID dei requisiti.
suiteType	string	Tipo di suite di test da creare. Può avere valore da DynamicTestSuite, StaticTestSuite e RequirementTestSuite.

Risposte

Nome	Tipo	Descrizione
200 OK	TestSuite[]	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

Based on a query

Based on requirements

Static suite

Based on a query

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1?api-version=5.0

{
  "suiteType": "DynamicTestSuite",
  "name": "AllTestCases",
  "queryString": "SELECT [System.Id],[System.WorkItemType],[System.Title],[Microsoft.VSTS.Common.Priority],[System.AssignedTo],[System.AreaPath] FROM WorkItems WHERE [System.WorkItemType] IN GROUP 'Microsoft.TestCaseCategory'"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 9,
      "name": "AllTestCases",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/9",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "plan": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
      },
      "parent": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
      },
      "queryString": "SELECT [System.Id],[System.WorkItemType],[System.Title],[Microsoft.VSTS.Common.Priority],[System.AssignedTo],[System.AreaPath] FROM WorkItems WHERE [System.WorkItemType] IN GROUP 'Microsoft.TestCaseCategory'",
      "revision": 1,
      "testCaseCount": 2,
      "suiteType": "DynamicTestSuite",
      "testCasesUrl": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/9/testcases",
      "inheritDefaultConfigurations": true,
      "lastPopulatedDate": "2014-05-04T11:33:28.497Z",
      "state": "InProgress",
      "lastUpdatedBy": {
        "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"
      },
      "lastUpdatedDate": "2014-05-04T11:33:28.497Z"
    }
  ],
  "count": 1
}

Based on requirements

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1?api-version=5.0

{
  "suiteType": "RequirementTestSuite",
  "requirementIds": [
    2
  ]
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 13,
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/13",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "plan": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
      },
      "parent": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
      },
      "name": "2 : BestFeatureEver",
      "requirementId": 2,
      "revision": 1,
      "testCaseCount": 0,
      "suiteType": "RequirementTestSuite",
      "testCasesUrl": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/13/testcases",
      "inheritDefaultConfigurations": true,
      "defaultConfigurations": [],
      "lastPopulatedDate": "2014-05-04T11:33:25.857Z",
      "state": "InProgress",
      "lastUpdatedBy": {
        "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"
      },
      "lastUpdatedDate": "2014-05-04T11:33:25.857Z",
      "areaUri": "vstfs:///Classification/Node/13a29f1c-46be-4883-9153-b36900f1b70c"
    }
  ],
  "count": 1
}

Static suite

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/suites/1?api-version=5.0

{
  "suiteType": "StaticTestSuite",
  "name": "NewTestSuite"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 8,
      "name": "NewTestSuite",
      "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/8",
      "project": {
        "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
        "name": "Fabrikam-Fiber-TFVC",
        "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
      },
      "plan": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
      },
      "parent": {
        "id": "1",
        "name": "sprint1",
        "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
      },
      "revision": 1,
      "testCaseCount": 0,
      "suiteType": "StaticTestSuite",
      "testCasesUrl": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/8/testcases",
      "inheritDefaultConfigurations": true,
      "state": "InProgress",
      "lastUpdatedBy": {
        "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"
      },
      "lastUpdatedDate": "2014-05-04T11:33:25.857Z"
    }
  ],
  "count": 1
}

Definizioni

Nome	Descrizione
IdentityRef
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
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.
SuiteCreateModel	Modello di creazione suite
TestSuite	Gruppo 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.

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

SuiteCreateModel

Modello di creazione suite

Nome	Tipo	Descrizione
name	string	Nome della suite di test.
queryString	string	Per le suite basate su query, la stringa di query che definisce la suite.
requirementIds	integer[]	Per i pacchetti di test dei requisiti, gli ID dei requisiti.
suiteType	string	Tipo di suite di test da creare. Può avere valore da DynamicTestSuite, StaticTestSuite e RequirementTestSuite.

TestSuite

Gruppo di test

Nome	Tipo	Descrizione
areaUri	string	URI dell'area della suite di test.
children	TestSuite[]	Gruppi di test figlio della suite di test corrente.
defaultConfigurations	ShallowReference[]	Configurazione predefinita della suite di test.
defaultTesters	ShallowReference[]	Testare i tester predefiniti della suite.
id	integer	ID della suite di test.
inheritDefaultConfigurations	boolean	La configurazione predefinita è stata ereditata o meno.
lastError	string	Ultimo errore per la suite di test.
lastPopulatedDate	string	Ultima data popolata.
lastUpdatedBy	IdentityRef	IdentityRef dell'utente che ha aggiornato di recente la suite di test.
lastUpdatedDate	string	Ultima data di aggiornamento.
name	string	Nome della suite di test.
parent	ShallowReference	Riferimento superficiale della suite di test.
plan	ShallowReference	Piano di test a cui appartiene la suite di test.
project	ShallowReference	Riferimento superficiale al progetto della suite di test.
queryString	string	Testare la stringa di query della suite per le suite dinamiche.
requirementId	integer	ID requisito della suite di test.
revision	integer	Revisione della suite di test.
state	string	Stato della suite di test.
suiteType	string	Tipo di suite di test.
suites	ShallowReference[]	Elenco dei riferimenti superficiali delle suite.
testCaseCount	integer	Conteggio dei test case.
testCasesUrl	string	URL del test case.
text	string	Usato nella visualizzazione albero. Se la suite di test è root suite, è il nome del piano altrimenti titolo della suite.
url	string	Url della suite di test.

Condividi tramite

Test Suites - Create

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Scopes

Esempio

Based on a query

Sample Request

Sample Response

Based on requirements

Sample Request

Sample Response

Static suite

Sample Request

Sample Response

Definizioni

IdentityRef

ReferenceLinks

ShallowReference

SuiteCreateModel

TestSuite

Risorse aggiuntive