Test Plans - Create

Odwołanie

Service:: Test

API Version:: 5.0

Utwórz plan testu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "5.0", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
area	ShallowReference	Ścieżka obszaru, do której należy plan testu. Powinno to być ustawione na ścieżkę obszaru zespołu, który pracuje nad tym planem testowym.
build	ShallowReference	Identyfikator kompilacji, której jakość jest testowana przez testy w tym planie testowym. W przypadku testowania automatycznego ten identyfikator kompilacji służy do znajdowania plików binarnych testów zawierających metody testów automatycznych.
buildDefinition	ShallowReference	Definicja kompilacji, która generuje kompilację skojarzona z tym planem testu.
configurationIds	integer[]	Identyfikatory konfiguracji, które mają być stosowane podczas dodawania nowych zestawów testów i przypadków testowych do planu testów.
description	string	Opis planu testu.
endDate	string	Data zakończenia planu testu.
iteration	string	Ścieżka iteracji przypisana do planu testu. Wskazuje to, kiedy docelowa iteracja, za pomocą której testy w tym planie mają zostać ukończone, a produkt jest gotowy do wydania.
name	string	Nazwa planu testu.
owner	IdentityRef	Właściciel planu testu.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Środowisko wydania używane do wdrażania kompilacji i uruchamiania testów automatycznych z tego planu testowego.
startDate	string	Data rozpoczęcia planu testu.
state	string	Stan planu testu.
testOutcomeSettings	TestOutcomeSettings	Ustawienia wyniku testu

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TestPlan	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.test_write	Umożliwia odczytywanie, tworzenie i aktualizowanie planów testów, przypadków, wyników i innych artefaktów związanych z zarządzaniem testami.

Przykłady

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

Definicje

Nazwa	Opis
IdentityRef
PlanUpdateModel	Klasa modelu używana do tworzenia i aktualizowania planów testów.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ReleaseEnvironmentDefinitionReference	Odwołanie do zasobu środowiska wydania.
ShallowReference	Abstrakcyjne odwołanie do innego zasobu. Ta klasa służy do dostarczania kontraktów danych kompilacji z jednolitym sposobem odwołowania się do innych zasobów w sposób, który zapewnia łatwy przechodzenie za pośrednictwem linków.
TestOutcomeSettings	Ustawienia wyników testu
TestPlan	Zasób planu testów.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

PlanUpdateModel

Klasa modelu używana do tworzenia i aktualizowania planów testów.

Nazwa	Typ	Opis
area	ShallowReference	Ścieżka obszaru, do której należy plan testu. Powinno to być ustawione na ścieżkę obszaru zespołu, który pracuje nad tym planem testowym.
build	ShallowReference	Identyfikator kompilacji, której jakość jest testowana przez testy w tym planie testowym. W przypadku testowania automatycznego ten identyfikator kompilacji służy do znajdowania plików binarnych testów zawierających metody testów automatycznych.
buildDefinition	ShallowReference	Definicja kompilacji, która generuje kompilację skojarzona z tym planem testu.
configurationIds	integer[]	Identyfikatory konfiguracji, które mają być stosowane podczas dodawania nowych zestawów testów i przypadków testowych do planu testów.
description	string	Opis planu testu.
endDate	string	Data zakończenia planu testu.
iteration	string	Ścieżka iteracji przypisana do planu testu. Wskazuje to, kiedy docelowa iteracja, za pomocą której testy w tym planie mają zostać ukończone, a produkt jest gotowy do wydania.
name	string	Nazwa planu testu.
owner	IdentityRef	Właściciel planu testu.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Środowisko wydania używane do wdrażania kompilacji i uruchamiania testów automatycznych z tego planu testowego.
startDate	string	Data rozpoczęcia planu testu.
state	string	Stan planu testu.
testOutcomeSettings	TestOutcomeSettings	Ustawienia wyniku testu

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

ReleaseEnvironmentDefinitionReference

Odwołanie do zasobu środowiska wydania.

Nazwa	Typ	Opis
definitionId	integer	Identyfikator definicji wydania zawierającej definicję środowiska wydania.
environmentDefinitionId	integer	Identyfikator definicji środowiska wydania.

ShallowReference

Abstrakcyjne odwołanie do innego zasobu. Ta klasa służy do dostarczania kontraktów danych kompilacji z jednolitym sposobem odwołowania się do innych zasobów w sposób, który zapewnia łatwy przechodzenie za pośrednictwem linków.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa połączonego zasobu (nazwa definicji, nazwa kontrolera itp.)
url	string	Pełny link http do zasobu

TestOutcomeSettings

Ustawienia wyników testu

Nazwa	Typ	Opis
syncOutcomeAcrossSuites	boolean	Wartość służąca do konfigurowania sposobu wyświetlania wyników testów dla tych samych testów między zestawami

TestPlan

Zasób planu testów.

Nazwa	Typ	Opis
area	ShallowReference	Obszar planu testu.
build	ShallowReference	Kompilacja do testowania.
buildDefinition	ShallowReference	Definicja kompilacji, która generuje kompilację skojarzona z tym planem testu.
description	string	Opis planu testu.
endDate	string	Data zakończenia planu testu.
id	integer	Identyfikator planu testu.
iteration	string	Ścieżka iteracji planu testu.
name	string	Nazwa planu testu.
owner	IdentityRef	Właściciel planu testu.
previousBuild	ShallowReference	Abstrakcyjne odwołanie do innego zasobu. Ta klasa służy do dostarczania kontraktów danych kompilacji z jednolitym sposobem odwołowania się do innych zasobów w sposób, który zapewnia łatwy przechodzenie za pośrednictwem linków.
project	ShallowReference	Projekt zawierający plan testu.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Środowisko wydania używane do wdrażania kompilacji i uruchamiania testów automatycznych z tego planu testowego.
revision	integer	Poprawka planu testu.
rootSuite	ShallowReference	Główny zestaw testów planu testu.
startDate	string	Data rozpoczęcia planu testu.
state	string	Stan planu testu.
testOutcomeSettings	TestOutcomeSettings	Wartość, aby skonfigurować, jak te same testy w zestawach testów w ramach planu testowego muszą zachowywać się
updatedBy	IdentityRef
updatedDate	string
url	string	Adres URL zasobu planu testów.

Udostępnij za pośrednictwem

Test Plans - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Scopes

Przykłady

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

Definicje

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan

Dodatkowe zasoby