Test Plans - Create

Reference

Služba:: Test

Verze rozhraní API:: 5.0

Vytvořte testovací plán.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na hodnotu 5.0.

Text požadavku

Name	Typ	Description
area	ShallowReference	Cesta oblasti, do které patří testovací plán. Toto nastavení by mělo být nastaveno na cestu oblasti týmu, který pracuje na tomto testovacím plánu.
build	ShallowReference	ID sestavení, jehož kvalita je testována testy v tomto testovacím plánu. Pro automatizované testování se toto ID sestavení používá k vyhledání testovacích binárních souborů, které obsahují automatizované testovací metody.
buildDefinition	ShallowReference	Definice sestavení, která generuje sestavení přidružené k tomuto testovacímu plánu.
configurationIds	integer[]	ID konfigurací, které se mají použít při přidání nových testovacích sad a testovacích případů do testovacího plánu
description	string	Popis testovacího plánu.
endDate	string	Koncové datum testovacího plánu.
iteration	string	Cesta iterace přiřazená k testovacímu plánu. To označuje, kdy cílová iterace, podle které má být testování v tomto plánu dokončeno, a produkt je připravený k vydání.
name	string	Název testovacího plánu.
owner	IdentityRef	Vlastník testovacího plánu.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Prostředí verze, které se použije k nasazení sestavení a spuštění automatizovaných testů z tohoto testovacího plánu.
startDate	string	Počáteční datum testovacího plánu.
state	string	Stav testovacího plánu.
testOutcomeSettings	TestOutcomeSettings	Nastavení výsledku testu

Odpovědi

Name	Typ	Description
200 OK	TestPlan	úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.test_write	Uděluje možnost číst, vytvářet a aktualizovat testovací plány, případy, výsledky a další artefakty související se správou testů.

Příklady

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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
IdentityRef
PlanUpdateModel	Třída modelu používaná k vytváření a aktualizaci testovacích plánů.
ReferenceLinks	Třída představující kolekci odkazů REST.
ReleaseEnvironmentDefinitionReference	Odkaz na prostředek prostředí verze
ShallowReference	Abstraktní odkaz na nějaký jiný prostředek. Tato třída se používá k poskytování kontraktů dat sestavení s jednotným způsobem odkazování na jiné prostředky způsobem, který umožňuje snadné procházení prostřednictvím odkazů.
TestOutcomeSettings	Nastavení výsledků testu
TestPlan	Prostředek testovacího plánu.

IdentityRef

Object

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

PlanUpdateModel

Object

Třída modelu používaná k vytváření a aktualizaci testovacích plánů.

Name	Typ	Description
area	ShallowReference	Cesta oblasti, do které patří testovací plán. Toto nastavení by mělo být nastaveno na cestu oblasti týmu, který pracuje na tomto testovacím plánu.
build	ShallowReference	ID sestavení, jehož kvalita je testována testy v tomto testovacím plánu. Pro automatizované testování se toto ID sestavení používá k vyhledání testovacích binárních souborů, které obsahují automatizované testovací metody.
buildDefinition	ShallowReference	Definice sestavení, která generuje sestavení přidružené k tomuto testovacímu plánu.
configurationIds	integer[]	ID konfigurací, které se mají použít při přidání nových testovacích sad a testovacích případů do testovacího plánu
description	string	Popis testovacího plánu.
endDate	string	Koncové datum testovacího plánu.
iteration	string	Cesta iterace přiřazená k testovacímu plánu. To označuje, kdy cílová iterace, podle které má být testování v tomto plánu dokončeno, a produkt je připravený k vydání.
name	string	Název testovacího plánu.
owner	IdentityRef	Vlastník testovacího plánu.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Prostředí verze, které se použije k nasazení sestavení a spuštění automatizovaných testů z tohoto testovacího plánu.
startDate	string	Počáteční datum testovacího plánu.
state	string	Stav testovacího plánu.
testOutcomeSettings	TestOutcomeSettings	Nastavení výsledku testu

ReferenceLinks

Object

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení.

ReleaseEnvironmentDefinitionReference

Object

Odkaz na prostředek prostředí verze

Name	Typ	Description
definitionId	integer	ID definice verze, která obsahuje definici prostředí vydané verze.
environmentDefinitionId	integer	ID definice prostředí vydané verze

ShallowReference

Object

Abstraktní odkaz na nějaký jiný prostředek. Tato třída se používá k poskytování kontraktů dat sestavení s jednotným způsobem odkazování na jiné prostředky způsobem, který umožňuje snadné procházení prostřednictvím odkazů.

Name	Typ	Description
id	string	ID prostředku
name	string	Název propojeného prostředku (název definice, název kontroleru atd.)
url	string	Úplný odkaz HTTP na prostředek

TestOutcomeSettings

Object

Nastavení výsledků testu

Name	Typ	Description
syncOutcomeAcrossSuites	boolean	Hodnota pro konfiguraci způsobu zobrazení výsledků testů pro stejné testy napříč sadami

TestPlan

Object

Prostředek testovacího plánu.

Name	Typ	Description
area	ShallowReference	Oblast testovacího plánu.
build	ShallowReference	Sestavení, které se má testovat.
buildDefinition	ShallowReference	Definice sestavení, která generuje sestavení přidružené k tomuto testovacímu plánu.
description	string	Popis testovacího plánu.
endDate	string	Koncové datum testovacího plánu.
id	integer	ID testovacího plánu.
iteration	string	Cesta iterace testovacího plánu.
name	string	Název testovacího plánu.
owner	IdentityRef	Vlastník testovacího plánu.
previousBuild	ShallowReference	Abstraktní odkaz na nějaký jiný prostředek. Tato třída se používá k poskytování kontraktů dat sestavení s jednotným způsobem odkazování na jiné prostředky způsobem, který umožňuje snadné procházení prostřednictvím odkazů.
project	ShallowReference	Projekt, který obsahuje testovací plán.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Prostředí verze, které se použije k nasazení sestavení a spuštění automatizovaných testů z tohoto testovacího plánu.
revision	integer	Revize testovacího plánu.
rootSuite	ShallowReference	Kořenová sada testů testovacího plánu.
startDate	string	Počáteční datum testovacího plánu.
state	string	Stav testovacího plánu.
testOutcomeSettings	TestOutcomeSettings	Hodnota konfigurace chování stejných testů napříč testovacími sadami v rámci testovacího plánu
updatedBy	IdentityRef
updatedDate	string
url	string	Adresa URL prostředku testovacího plánu

Sdílet prostřednictvím

Test Plans - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Create a test plan in an area and iteration.

Ukázkový požadavek

Ukázková odpověď

Create a test plan with a description.

Ukázkový požadavek

Ukázková odpověď

Create a test plan with start date and end date.

Ukázkový požadavek

Ukázková odpověď

Definice

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Další materiály