Test Plans - Create

Reference

Služba:: Test Plan

Verze rozhraní API:: 7.1

Vytvořte testovací plán.

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

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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Text požadavku

Name	Typ	Description
areaPath	string	Oblast testovacího plánu.
buildDefinition	BuildDefinitionReference	Definice sestavení, která generuje sestavení přidružené k tomuto testovacímu plánu.
buildId	integer (int32)	Sestavení, které se má testovat.
description	string	Popis testovacího plánu
endDate	string (date-time)	Koncové datum 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.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Prostředí vydaných verzí, které se použije k nasazení sestavení a spuštění automatizovaných testů z tohoto testovacího plánu.
startDate	string (date-time)	Počáteční datum testovacího plánu
state	string	Stav testovacího plánu.
testOutcomeSettings	TestOutcomeSettings	Hodnota konfigurace toho, jak se musí chovat stejné testy napříč testovacími sadami v rámci testovacího plánu

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 with all details.

Create a test plan with name, area path and iteration.

Create a test plan with all details.

Ukázkový požadavek

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans?api-version=7.1

{
  "name": "newCreatedPlan2",
  "areaPath": "sampleProject\\Team1",
  "description": "description of the test plan",
  "startDate": "2018-08-19T20:49:15.8884886+05:30",
  "endDate": "2018-08-26T20:49:15.8884886+05:30",
  "iteration": "sampleProject\\Iteration 2",
  "owner": null,
  "state": "Inactive",
  "buildId": 3,
  "buildDefinition": {
    "id": 2,
    "name": ""
  },
  "releaseEnvironmentDefinition": {
    "definitionId": 1,
    "environmentDefinitionId": 1
  },
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "id": 31,
  "project": {
    "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
    "name": "sampleProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "updatedDate": "2018-08-17T15:19:16.993Z",
  "updatedBy": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "rootSuite": {
    "id": 32,
    "name": "newCreatedPlan2",
    "plan": {
      "id": 31,
      "name": "newCreatedPlan2"
    }
  },
  "_links": {
    "_self": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/31"
    },
    "clientUrl": {
      "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=31"
    },
    "rootSuite": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/31/Suites/32"
    },
    "build": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Builds/3"
    },
    "buildDefinition": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/build/Definitions/2"
    }
  },
  "revision": 2,
  "name": "newCreatedPlan2",
  "areaPath": "sampleProject\\Team1",
  "description": "description of the test plan",
  "startDate": "2018-08-19T20:49:15.8884886+05:30",
  "endDate": "2018-08-26T20:49:15.8884886+05:30",
  "iteration": "sampleProject\\Iteration 2",
  "owner": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "state": "Inactive",
  "buildId": 3,
  "buildDefinition": {
    "id": 2,
    "name": ""
  },
  "releaseEnvironmentDefinition": {
    "definitionId": 1,
    "environmentDefinitionId": 1
  },
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": true
  }
}

Create a test plan with name, area path and iteration.

Ukázkový požadavek

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/testplan/plans?api-version=7.1

{
  "name": "newCreatedPlan1",
  "areaPath": "sampleProject\\Team1",
  "iteration": "sampleProject\\Iteration 2",
  "owner": null
}

Ukázková odpověď

Stavový kód:: 200

{
  "id": 29,
  "project": {
    "id": "afb62ab2-bd74-41c2-991e-40bbb9c8ca91",
    "name": "sampleProject",
    "state": "unchanged",
    "visibility": "unchanged"
  },
  "updatedDate": "2018-08-17T15:19:13.967Z",
  "updatedBy": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "rootSuite": {
    "id": 30,
    "name": "newCreatedPlan1",
    "plan": {
      "id": 29,
      "name": "newCreatedPlan1"
    }
  },
  "_links": {
    "_self": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/29"
    },
    "clientUrl": {
      "href": "mtms://fabrikam.visualstudio.com:443/p:sampleProject/Testing/testplan/connect?id=29"
    },
    "rootSuite": {
      "href": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/29/Suites/30"
    }
  },
  "revision": 1,
  "name": "newCreatedPlan1",
  "areaPath": "sampleProject\\Team1",
  "startDate": "2018-08-17T15:19:13.6734848Z",
  "endDate": "2018-08-24T15:19:13.6734848Z",
  "iteration": "sampleProject\\Iteration 2",
  "owner": {
    "displayName": "Fabrikam Fiber",
    "url": "https://vssps.dev.azure.com/fabrikam/Aea08ebc7-105f-4bb2-a36b-f92e0e9de65a/_apis/Identities/0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
      }
    },
    "id": "0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "uniqueName": "fabrikamfiber1@microsoft.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=0fdbdad8-6afb-6149-9af9-c0a216137d1d",
    "descriptor": "aad.MGZkYmRhZDgtNmFmYi03MTQ5LTlhZjktYzBhMjE2MTM3ZDFk"
  },
  "state": "Active",
  "testOutcomeSettings": {
    "syncOutcomeAcrossSuites": false
  }
}

Definice

Name	Description
BuildDefinitionReference	Referenční prostředek definice sestavení
IdentityRef
ProjectState	Stav projektu
ProjectVisibility	Viditelnost projektu
ReferenceLinks	Třída představující kolekci odkazů REST.
ReleaseEnvironmentDefinitionReference	Odkaz na prostředek prostředí verze
TeamProjectReference	Představuje mělký odkaz na TeamProject.
TestOutcomeSettings	Nastavení výsledků testu
TestPlan	Zdroj testovacího plánu.
TestPlanCreateParams	Testovací plán vytvoří parametry.
TestSuiteReference	Referenční prostředek sady testů.

BuildDefinitionReference

Objekt

Referenční prostředek definice sestavení

Name	Typ	Description
id	integer (int32)	ID definice sestavení
name	string	Název definice sestavení

IdentityRef

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy 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 tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ProjectState

Výčet

Stav projektu

Hodnota	Description
all	Všechny projekty bez ohledu na stav kromě Odstraněno.
createPending	Projekt byl zařazen do fronty pro vytvoření, ale proces ještě nebyl spuštěn.
deleted	Projekt byl odstraněn.
deleting	Projekt probíhá v procesu odstranění.
new	Projekt probíhá při vytváření.
unchanged	Projekt nebyl změněn.
wellFormed	Projekt je zcela vytvořený a připravený k použití.

ProjectVisibility

Výčet

Viditelnost projektu

Hodnota	Description
private	Projekt je viditelný jenom uživatelům s explicitním přístupem.
public	Projekt je viditelný pro všechny.

ReferenceLinks

Objekt

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

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

ReleaseEnvironmentDefinitionReference

Objekt

Odkaz na prostředek prostředí verze

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

TeamProjectReference

Objekt

Představuje mělký odkaz na TeamProject.

Name	Typ	Description
abbreviation	string	Zkratka projektu.
defaultTeamImageUrl	string	Adresa URL výchozí image týmové identity
description	string	Popis projektu (pokud existuje).
id	string (uuid)	Identifikátor projektu.
lastUpdateTime	string (date-time)	Čas poslední aktualizace projektu
name	string	Název projektu.
revision	integer (int64)	Revize projektu
state	ProjectState	Stav projektu
url	string	Adresa URL úplné verze objektu.
visibility	ProjectVisibility	Viditelnost projektu

TestOutcomeSettings

Objekt

Nastavení výsledků testu

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

TestPlan

Objekt

Zdroj testovacího plánu.

Name	Typ	Description
_links	ReferenceLinks	Relevantní odkazy
areaPath	string	Oblast testovacího plánu.
buildDefinition	BuildDefinitionReference	Definice sestavení, která generuje sestavení přidružené k tomuto testovacímu plánu.
buildId	integer (int32)	Sestavení, které se má testovat.
description	string	Popis testovacího plánu
endDate	string (date-time)	Koncové datum testovacího plánu.
id	integer (int32)	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.
previousBuildId	integer (int32)	Předchozí ID sestavení přidružené k testovacímu plánu
project	TeamProjectReference	Projekt, který obsahuje testovací plán
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Prostředí vydaných verzí, které se použije k nasazení sestavení a spuštění automatizovaných testů z tohoto testovacího plánu.
revision	integer (int32)	Revize testovacího plánu
rootSuite	TestSuiteReference	Kořenová sada testů testovacího plánu
startDate	string (date-time)	Počáteční datum testovacího plánu
state	string	Stav testovacího plánu.
testOutcomeSettings	TestOutcomeSettings	Hodnota konfigurace toho, jak se musí chovat stejné testy napříč testovacími sadami v rámci testovacího plánu
updatedBy	IdentityRef	Referenční informace k identitě pro poslední aktualizaci testovacího plánu
updatedDate	string (date-time)	Datum aktualizace testovacího plánu

TestPlanCreateParams

Objekt

Testovací plán vytvoří parametry.

Name	Typ	Description
areaPath	string	Oblast testovacího plánu.
buildDefinition	BuildDefinitionReference	Definice sestavení, která generuje sestavení přidružené k tomuto testovacímu plánu.
buildId	integer (int32)	Sestavení, které se má testovat.
description	string	Popis testovacího plánu
endDate	string (date-time)	Koncové datum 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.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Prostředí vydaných verzí, které se použije k nasazení sestavení a spuštění automatizovaných testů z tohoto testovacího plánu.
startDate	string (date-time)	Počáteční datum testovacího plánu
state	string	Stav testovacího plánu.
testOutcomeSettings	TestOutcomeSettings	Hodnota konfigurace toho, jak se musí chovat stejné testy napříč testovacími sadami v rámci testovacího plánu

TestSuiteReference

Objekt

Referenční prostředek sady testů.

Name	Typ	Description
id	integer (int32)	ID testovací sady.
name	string	Název testovací sady.

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 with all details.

Ukázkový požadavek

Ukázková odpověď

Create a test plan with name, area path and iteration.

Ukázkový požadavek

Ukázková odpověď

Definice

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference