Test Plans - Create

Odwołanie

Usługa:: Test Plan

Wersja interfejsu API:: 7.1

Utwórz plan testu.

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

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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
areaPath	string	Obszar planu testowego.
buildDefinition	BuildDefinitionReference	Definicja kompilacji, która generuje kompilację skojarzona z tym planem testu.
buildId	integer (int32)	Kompilacja do przetestowania.
description	string	Opis planu testu.
endDate	string (date-time)	Data zakończenia planu testu.
iteration	string	Ścieżka iteracji planu testu.
name	string	Nazwa planu testu.
owner	IdentityRef	Właściciel planu testowego.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Środowisko wydania używane do wdrażania kompilacji i uruchamiania testów automatycznych z tego planu testowego.
startDate	string (date-time)	Data rozpoczęcia planu testowego.
state	string	Stan planu testu.
testOutcomeSettings	TestOutcomeSettings	Wartość, aby skonfigurować, jak te same testy między zestawami testów w ramach planu testowego muszą zachowywać się

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TestPlan	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

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

Zakresy

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

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

Create a test plan with all details.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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.

Przykładowe żądanie

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
}

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
BuildDefinitionReference	Zasób referencyjny definicji kompilacji
IdentityRef
ProjectState	Stan projektu.
ProjectVisibility	Widoczność projektu.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ReleaseEnvironmentDefinitionReference	Odwołanie do zasobu środowiska wydania.
TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.
TestOutcomeSettings	Ustawienia wyników testu
TestPlan	Zasób planu testów.
TestPlanCreateParams	Plan testu tworzy parametry.
TestSuiteReference	Zasób referencyjny zestawu testów.

BuildDefinitionReference

Objekt

Zasób referencyjny definicji kompilacji

Nazwa	Typ	Opis
id	integer (int32)	Identyfikator definicji kompilacji
name	string	Nazwa definicji kompilacji

IdentityRef

Objekt

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	Przestarzałe — można go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

ProjectState

Wyliczanie

Stan projektu.

Wartość	Opis
all	Wszystkie projekty niezależnie od stanu z wyjątkiem usuniętych.
createPending	Projekt został jeszcze w kolejce do utworzenia, ale proces nie został jeszcze uruchomiony.
deleted	Projekt został usunięty.
deleting	Projekt jest w trakcie usuwania.
new	Projekt jest w trakcie tworzenia.
unchanged	Projekt nie został zmieniony.
wellFormed	Projekt jest całkowicie tworzony i gotowy do użycia.

ProjectVisibility

Wyliczanie

Widoczność projektu.

Wartość	Opis
private	Projekt jest widoczny tylko dla użytkowników z jawnym dostępem.
public	Projekt jest widoczny dla wszystkich.

ReferenceLinks

Objekt

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

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

ReleaseEnvironmentDefinitionReference

Objekt

Odwołanie do zasobu środowiska wydania.

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

TeamProjectReference

Objekt

Reprezentuje płytkie odwołanie do projektu TeamProject.

Nazwa	Typ	Opis
abbreviation	string	Skrót projektu.
defaultTeamImageUrl	string	Adres URL domyślnego obrazu tożsamości zespołu.
description	string	Opis projektu (jeśli istnieje).
id	string (uuid)	Identyfikator projektu.
lastUpdateTime	string (date-time)	Czas ostatniej aktualizacji projektu.
name	string	Nazwa projektu.
revision	integer (int64)	Poprawka projektu.
state	ProjectState	Stan projektu.
url	string	Adres URL do pełnej wersji obiektu.
visibility	ProjectVisibility	Widoczność projektu.

TestOutcomeSettings

Objekt

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

Objekt

Zasób planu testów.

Nazwa	Typ	Opis
_links	ReferenceLinks	Odpowiednie linki
areaPath	string	Obszar planu testowego.
buildDefinition	BuildDefinitionReference	Definicja kompilacji, która generuje kompilację skojarzona z tym planem testu.
buildId	integer (int32)	Kompilacja do przetestowania.
description	string	Opis planu testu.
endDate	string (date-time)	Data zakończenia planu testu.
id	integer (int32)	Identyfikator planu testowego.
iteration	string	Ścieżka iteracji planu testu.
name	string	Nazwa planu testu.
owner	IdentityRef	Właściciel planu testowego.
previousBuildId	integer (int32)	Poprzedni identyfikator kompilacji skojarzony z planem testu
project	TeamProjectReference	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 (int32)	Poprawka planu testowego.
rootSuite	TestSuiteReference	Zestaw testów głównych planu testowego.
startDate	string (date-time)	Data rozpoczęcia planu testowego.
state	string	Stan planu testu.
testOutcomeSettings	TestOutcomeSettings	Wartość, aby skonfigurować, jak te same testy między zestawami testów w ramach planu testowego muszą zachowywać się
updatedBy	IdentityRef	Odwołanie do tożsamości dla ostatniej aktualizacji planu testowego
updatedDate	string (date-time)	Zaktualizowano datę planu testu

TestPlanCreateParams

Objekt

Plan testu tworzy parametry.

Nazwa	Typ	Opis
areaPath	string	Obszar planu testowego.
buildDefinition	BuildDefinitionReference	Definicja kompilacji, która generuje kompilację skojarzona z tym planem testu.
buildId	integer (int32)	Kompilacja do przetestowania.
description	string	Opis planu testu.
endDate	string (date-time)	Data zakończenia planu testu.
iteration	string	Ścieżka iteracji planu testu.
name	string	Nazwa planu testu.
owner	IdentityRef	Właściciel planu testowego.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Środowisko wydania używane do wdrażania kompilacji i uruchamiania testów automatycznych z tego planu testowego.
startDate	string (date-time)	Data rozpoczęcia planu testowego.
state	string	Stan planu testu.
testOutcomeSettings	TestOutcomeSettings	Wartość, aby skonfigurować, jak te same testy między zestawami testów w ramach planu testowego muszą zachowywać się

TestSuiteReference

Objekt

Zasób referencyjny zestawu testów.

Nazwa	Typ	Opis
id	integer (int32)	Identyfikator zestawu testów.
name	string	Nazwa zestawu testów.

Udostępnij przez

Test Plans - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Create a test plan with all details.

Przykładowe żądanie

Przykładowa odpowiedź

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

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference