Test Plans - Update

Referensi

Layanan:: Test

Versi API:: 5.0

Memperbarui paket pengujian.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
planId	path	True	integer int32	ID rencana pengujian yang akan diperbarui.
project	path	True	string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '5.0' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
area	ShallowReference	Jalur area tempat rencana pengujian berada. Ini harus diatur ke jalur area tim yang bekerja pada rencana pengujian ini.
build	ShallowReference	Bangun ID build yang kualitasnya diuji oleh pengujian dalam rencana pengujian ini. Untuk pengujian otomatis, ID build ini digunakan untuk menemukan biner pengujian yang berisi metode pengujian otomatis.
buildDefinition	ShallowReference	Definisi Build yang menghasilkan build yang terkait dengan rencana pengujian ini.
configurationIds	integer[]	ID konfigurasi yang akan diterapkan ketika rangkaian pengujian dan kasus pengujian baru ditambahkan ke rencana pengujian.
description	string	Deskripsi rencana pengujian.
endDate	string	Tanggal selesai untuk paket pengujian.
iteration	string	Jalur perulangan yang ditetapkan ke rencana pengujian. Ini menunjukkan kapan perulangan target di mana pengujian dalam rencana ini seharusnya selesai dan produk siap dirilis.
name	string	Nama rencana pengujian.
owner	IdentityRef	Pemilik rencana pengujian.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Lingkungan Rilis yang akan digunakan untuk menyebarkan build dan menjalankan pengujian otomatis dari rencana pengujian ini.
startDate	string	Tanggal mulai untuk paket pengujian.
state	string	Status rencana pengujian.
testOutcomeSettings	TestOutcomeSettings	Menguji pengaturan Hasil

Respons

Nama	Jenis	Deskripsi
200 OK	TestPlan	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Cakupan

Nama	Deskripsi
vso.test_write	Memberikan kemampuan untuk membaca, membuat, dan memperbarui rencana pengujian, kasus, hasil, dan artefak terkait manajemen pengujian lainnya.

Contoh

Update area and iteration of a test plan.

Update name and description of a test plan.

Update name of a test plan.

Update state of a test plan.

Update area and iteration of a test plan.

Permintaan sampel

HTTP

PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/17?api-version=5.0

{
  "area": {
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1"
}

Respon sampel

Kode status:: 200

{
  "id": 17,
  "name": "newCreatedPlan2",
  "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": "411",
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "description": "Our new plan",
  "startDate": "2014-05-01T00:00:00Z",
  "endDate": "2014-05-10T00:00:00Z",
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1",
  "updatedDate": "2014-05-06T13:43:09.787Z",
  "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": 3,
  "state": "Active",
  "rootSuite": {
    "id": "34",
    "name": "newCreatedPlan2",
    "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"
}

Update name and description of a test plan.

Permintaan sampel

HTTP

PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/17?api-version=5.0

{
  "name": "newCreatedPlan2",
  "description": "Our new plan"
}

Respon sampel

Kode status:: 200

{
  "id": 17,
  "name": "newCreatedPlan2",
  "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"
  },
  "description": "Our new plan",
  "startDate": "2014-05-01T00:00:00Z",
  "endDate": "2014-05-10T00:00:00Z",
  "iteration": "Fabrikam-Fiber-TFVC",
  "updatedDate": "2014-05-06T13:43:07.247Z",
  "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": 2,
  "state": "Active",
  "rootSuite": {
    "id": "34",
    "name": "newCreatedPlan2",
    "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"
}

Update name of a test plan.

Permintaan sampel

HTTP

PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/218?api-version=5.0

{
  "name": "newCreatedPlan2"
}

Respon sampel

Kode status:: 200

{
  "id": 218,
  "name": "newCreatedPlan2",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/218",
  "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": "",
  "startDate": "2014-10-07T22:18:49.7Z",
  "endDate": "2014-10-14T22:18:49.7Z",
  "iteration": "Fabrikam-Fiber-TFVC",
  "updatedDate": "2014-10-07T22:18:50.333Z",
  "updatedBy": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "owner": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "revision": 2,
  "state": "Active",
  "rootSuite": {
    "id": "219",
    "name": "newCreatedPlan2",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/218/Suites/219"
  },
  "clientUrl": "mtms://fabrikam.visualstudio.com:443/DefaultCollection/p:Fabrikam-Fiber-TFVC/Testing/testplan/connect?id=218"
}

Update state of a test plan.

Permintaan sampel

HTTP

PATCH https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/plans/17?api-version=5.0

{
  "state": "Inactive"
}

Respon sampel

Kode status:: 200

{
  "id": 17,
  "name": "newCreatedPlan2",
  "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": "411",
    "name": "Fabrikam-Fiber-TFVC\\Quality assurance"
  },
  "description": "Our new plan",
  "startDate": "2014-05-01T00:00:00Z",
  "endDate": "2014-05-10T00:00:00Z",
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1",
  "updatedDate": "2014-05-06T13:43:13.17Z",
  "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": 4,
  "state": "Inactive",
  "rootSuite": {
    "id": "34",
    "name": "newCreatedPlan2",
    "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"
}

Definisi

Nama	Deskripsi
IdentityRef
PlanUpdateModel	Kelas model yang digunakan untuk membuat dan memperbarui rencana pengujian.
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
ReleaseEnvironmentDefinitionReference	Referensi untuk merilis sumber daya lingkungan.
ShallowReference	Referensi abstrak ke beberapa sumber daya lain. Kelas ini digunakan untuk menyediakan kontrak data build dengan cara yang seragam untuk mereferensikan sumber daya lain dengan cara yang menyediakan traversal yang mudah melalui tautan.
TestOutcomeSettings	Menguji pengaturan hasil
TestPlan	Sumber daya rencana pengujian.

IdentityRef

Objek

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

PlanUpdateModel

Objek

Kelas model yang digunakan untuk membuat dan memperbarui rencana pengujian.

Nama	Jenis	Deskripsi
area	ShallowReference	Jalur area tempat rencana pengujian berada. Ini harus diatur ke jalur area tim yang bekerja pada rencana pengujian ini.
build	ShallowReference	Bangun ID build yang kualitasnya diuji oleh pengujian dalam rencana pengujian ini. Untuk pengujian otomatis, ID build ini digunakan untuk menemukan biner pengujian yang berisi metode pengujian otomatis.
buildDefinition	ShallowReference	Definisi Build yang menghasilkan build yang terkait dengan rencana pengujian ini.
configurationIds	integer[]	ID konfigurasi yang akan diterapkan ketika rangkaian pengujian dan kasus pengujian baru ditambahkan ke rencana pengujian.
description	string	Deskripsi rencana pengujian.
endDate	string	Tanggal selesai untuk paket pengujian.
iteration	string	Jalur perulangan yang ditetapkan ke rencana pengujian. Ini menunjukkan kapan perulangan target di mana pengujian dalam rencana ini seharusnya selesai dan produk siap dirilis.
name	string	Nama rencana pengujian.
owner	IdentityRef	Pemilik rencana pengujian.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Lingkungan Rilis yang akan digunakan untuk menyebarkan build dan menjalankan pengujian otomatis dari rencana pengujian ini.
startDate	string	Tanggal mulai untuk paket pengujian.
state	string	Status rencana pengujian.
testOutcomeSettings	TestOutcomeSettings	Menguji pengaturan Hasil

ReferenceLinks

Objek

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

ReleaseEnvironmentDefinitionReference

Objek

Referensi untuk merilis sumber daya lingkungan.

Nama	Jenis	Deskripsi
definitionId	integer	ID definisi rilis yang berisi definisi lingkungan rilis.
environmentDefinitionId	integer	ID definisi lingkungan rilis.

ShallowReference

Objek

Referensi abstrak ke beberapa sumber daya lain. Kelas ini digunakan untuk menyediakan kontrak data build dengan cara yang seragam untuk mereferensikan sumber daya lain dengan cara yang menyediakan traversal yang mudah melalui tautan.

Nama	Jenis	Deskripsi
id	string	ID sumber daya
name	string	Nama sumber daya yang ditautkan (nama definisi, nama pengontrol, dll.)
url	string	Tautan http lengkap ke sumber daya

TestOutcomeSettings

Objek

Menguji pengaturan hasil

Nama	Jenis	Deskripsi
syncOutcomeAcrossSuites	boolean	Nilai untuk mengonfigurasi bagaimana hasil pengujian untuk pengujian yang sama di seluruh suite ditampilkan

TestPlan

Objek

Sumber daya rencana pengujian.

Nama	Jenis	Deskripsi
area	ShallowReference	Area rencana pengujian.
build	ShallowReference	Bangun untuk diuji.
buildDefinition	ShallowReference	Definisi Build yang menghasilkan build yang terkait dengan rencana pengujian ini.
description	string	Deskripsi rencana pengujian.
endDate	string	Tanggal selesai untuk paket pengujian.
id	integer	ID rencana pengujian.
iteration	string	Jalur iterasi rencana pengujian.
name	string	Nama rencana pengujian.
owner	IdentityRef	Pemilik rencana pengujian.
previousBuild	ShallowReference	Referensi abstrak ke beberapa sumber daya lain. Kelas ini digunakan untuk menyediakan kontrak data build dengan cara yang seragam untuk mereferensikan sumber daya lain dengan cara yang menyediakan traversal yang mudah melalui tautan.
project	ShallowReference	Proyek yang berisi rencana pengujian.
releaseEnvironmentDefinition	ReleaseEnvironmentDefinitionReference	Lingkungan Rilis yang akan digunakan untuk menyebarkan build dan menjalankan pengujian otomatis dari rencana pengujian ini.
revision	integer	Revisi rencana pengujian.
rootSuite	ShallowReference	Rangkaian pengujian akar dari rencana pengujian.
startDate	string	Tanggal mulai untuk paket pengujian.
state	string	Status rencana pengujian.
testOutcomeSettings	TestOutcomeSettings	Nilai untuk mengonfigurasi bagaimana pengujian yang sama di seluruh rangkaian pengujian di bawah rencana pengujian perlu berperilaku
updatedBy	IdentityRef
updatedDate	string
url	string	URL sumber daya paket pengujian.

Bagikan melalui

Test Plans - Update

Parameter URI

Isi Permintaan

Respons

Keamanan

oauth2

Cakupan

Contoh

Update area and iteration of a test plan.

Permintaan sampel

Respon sampel

Update name and description of a test plan.

Permintaan sampel

Respon sampel

Update name of a test plan.

Permintaan sampel

Respon sampel

Update state of a test plan.

Permintaan sampel

Respon sampel

Definisi

IdentityRef

PlanUpdateModel

ReferenceLinks

ReleaseEnvironmentDefinitionReference

ShallowReference

TestOutcomeSettings

TestPlan