Test Plans - Create

Başvuru

Hizmet:: Test Plan

API Sürümü:: 7.1

Bir test planı oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path	True	string	Proje kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
areaPath	string	Test planının alanı.
buildDefinition	BuildDefinitionReference	Bu test planıyla ilişkilendirilmiş bir derleme oluşturan Derleme Tanımı.
buildId	integer (int32)	Test edilecek derleme.
description	string	Test planının açıklaması.
endDate	string (date-time)	Test planının bitiş tarihi.
iteration	string	Test planının yineleme yolu.
name	string	Test planının adı.
owner	IdentityRef	Test planının sahibi.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Derlemeyi dağıtmak ve bu test planından otomatikleştirilmiş testleri çalıştırmak için kullanılacak Yayın Ortamı.
startDate	string (date-time)	Test planının başlangıç tarihi.
state	string	Test planının durumu.
testOutcomeSettings	TestOutcomeSettings	Bir test planı altındaki test paketleri arasında aynı testlerin nasıl davranması gerektiğini yapılandırma değeri

Yanıtlar

Name	Tür	Description
200 OK	TestPlan	başarılı işlem

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

Name	Description
vso.test_write	Test planlarını, çalışmaları, sonuçları ve test yönetimiyle ilgili diğer yapıtları okuma, oluşturma ve güncelleştirme olanağı sağlar.

Örnekler

Create a test plan with all details.

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

Create a test plan with all details.

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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.

Örnek isteği

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
}

Örnek yanıt

Durum kodu:: 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
  }
}

Tanımlar

Name	Description
BuildDefinitionReference	Derleme tanımı başvuru kaynağı
IdentityRef
ProjectState	Proje durumu.
ProjectVisibility	Proje görünürlüğü.
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
ReleaseEnvironmentDefinitionReference	Yayın ortamı kaynağına başvuru.
TeamProjectReference	TeamProject'e basit bir başvuru temsil eder.
TestOutcomeSettings	Test sonucu ayarları
TestPlan	Test planı kaynağı.
TestPlanCreateParams	Test planı parametreler oluşturur.
TestSuiteReference	Test paketi başvuru kaynağı.

BuildDefinitionReference

Object

Derleme tanımı başvuru kaynağı

Name	Tür	Description
id	integer (int32)	Derleme tanımının kimliği
name	string	Derleme tanımının adı

IdentityRef

Object

Name	Tür	Description
_links	ReferenceLinks	Bu alan, grafik konusu hakkında sıfır veya daha fazla ilginç bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor	string	Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias	string	Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
displayName	string	Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id	string
imageUrl	string	Kullanım dışı - IdentityRef "_links" sözlüğün "avatar" girişinde kullanılabilir
inactive	boolean	Kullanım dışı - GraphUser "_links" sözlüğündeki "membershipState" girdisinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Tanımlayıcı.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName	string	Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url	string	Bu url, bu grafik konusunun kaynak kaynağına giden tam yoldur.

ProjectState

Listeleme

Proje durumu.

Değer	Description
all	Durumu ne olursa olsun, Silinmiş dışındaki tüm projeler.
createPending	Proje oluşturma için kuyruğa alındı, ancak işlem henüz başlamadı.
deleted	Proje silindi.
deleting	Project siliniyor.
new	Proje oluşturulma aşamasındadır.
unchanged	Proje değiştirilmedi.
wellFormed	Proje tamamen oluşturulur ve kullanıma hazırdır.

ProjectVisibility

Listeleme

Proje görünürlüğü.

Değer	Description
private	Proje yalnızca açık erişimi olan kullanıcılar tarafından görülebilir.
public	Proje herkes tarafından görülebilir.

ReferenceLinks

Object

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz.

ReleaseEnvironmentDefinitionReference

Object

Yayın ortamı kaynağına başvuru.

Name	Tür	Description
definitionId	integer (int32)	Yayın ortamı tanımını içeren yayın tanımının kimliği.
environmentDefinitionId	integer (int32)	Yayın ortamı tanımının kimliği.

TeamProjectReference

Object

TeamProject'e basit bir başvuru temsil eder.

Name	Tür	Description
abbreviation	string	Proje kısaltması.
defaultTeamImageUrl	string	Varsayılan ekip kimliği görüntüsünün URL'si.
description	string	Projenin açıklaması (varsa).
id	string (uuid)	Proje tanımlayıcısı.
lastUpdateTime	string (date-time)	Proje son güncelleştirme zamanı.
name	string	Proje adı.
revision	integer (int64)	Proje düzeltmesi.
state	ProjectState	Proje durumu.
url	string	Nesnenin tam sürümünün URL'si.
visibility	ProjectVisibility	Proje görünürlüğü.

TestOutcomeSettings

Object

Test sonucu ayarları

Name	Tür	Description
syncOutcomeAcrossSuites	boolean	Paketler arasında aynı testlerin test sonuçlarının nasıl gösterileceğini yapılandırma değeri

TestPlan

Object

Test planı kaynağı.

Name	Tür	Description
_links	ReferenceLinks	İlgili bağlantılar
areaPath	string	Test planının alanı.
buildDefinition	BuildDefinitionReference	Bu test planıyla ilişkilendirilmiş bir derleme oluşturan Derleme Tanımı.
buildId	integer (int32)	Test edilecek derleme.
description	string	Test planının açıklaması.
endDate	string (date-time)	Test planının bitiş tarihi.
id	integer (int32)	Test planının kimliği.
iteration	string	Test planının yineleme yolu.
name	string	Test planının adı.
owner	IdentityRef	Test planının sahibi.
previousBuildId	integer (int32)	Test planıyla ilişkili önceki derleme kimliği
project	TeamProjectReference	Test planını içeren Proje.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Derlemeyi dağıtmak ve bu test planından otomatikleştirilmiş testleri çalıştırmak için kullanılacak Yayın Ortamı.
revision	integer (int32)	Test planının düzeltmesi.
rootSuite	TestSuiteReference	Test planının kök test paketi.
startDate	string (date-time)	Test planının başlangıç tarihi.
state	string	Test planının durumu.
testOutcomeSettings	TestOutcomeSettings	Bir test planı altındaki test paketleri arasında aynı testlerin nasıl davranması gerektiğini yapılandırma değeri
updatedBy	IdentityRef	Test planının son güncelleştirmesi için Kimlik Başvurusu
updatedDate	string (date-time)	Test planının güncelleştirilmiş tarihi

TestPlanCreateParams

Object

Test planı parametreler oluşturur.

Name	Tür	Description
areaPath	string	Test planının alanı.
buildDefinition	BuildDefinitionReference	Bu test planıyla ilişkilendirilmiş bir derleme oluşturan Derleme Tanımı.
buildId	integer (int32)	Test edilecek derleme.
description	string	Test planının açıklaması.
endDate	string (date-time)	Test planının bitiş tarihi.
iteration	string	Test planının yineleme yolu.
name	string	Test planının adı.
owner	IdentityRef	Test planının sahibi.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Derlemeyi dağıtmak ve bu test planından otomatikleştirilmiş testleri çalıştırmak için kullanılacak Yayın Ortamı.
startDate	string (date-time)	Test planının başlangıç tarihi.
state	string	Test planının durumu.
testOutcomeSettings	TestOutcomeSettings	Bir test planı altındaki test paketleri arasında aynı testlerin nasıl davranması gerektiğini yapılandırma değeri

TestSuiteReference

Object

Test paketi başvuru kaynağı.

Name	Tür	Description
id	integer (int32)	Test paketinin kimliği.
name	string	Test paketinin adı.

Aracılığıyla paylaş

Test Plans - Create

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

oauth2

Kapsamlar

Örnekler

Create a test plan with all details.

Örnek isteği

Örnek yanıt

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

Örnek isteği

Örnek yanıt

Tanımlar

BuildDefinitionReference

IdentityRef

ProjectState

ProjectVisibility

ReferenceLinks

ReleaseEnvironmentDefinitionReference

TeamProjectReference

TestOutcomeSettings

TestPlan

TestPlanCreateParams

TestSuiteReference