Approvals - Query
Daftar Persetujuan. Ini dapat digunakan untuk mendapatkan serangkaian persetujuan yang tertunda dalam alur, pada pengguna atau untuk sumber daya..
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds={approvalIds}&$expand={$expand}&userIds={userIds}&state={state}&top={top}&api-version=7.1-preview.1
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
organization
|
path | True |
string |
Nama organisasi Azure DevOps. |
project
|
path | True |
string |
ID proyek atau nama proyek |
api-version
|
query | True |
string |
Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini. |
$expand
|
query |
Sertakan detail tambahan ini dalam objek yang dikembalikan. |
||
approval
|
query |
string array (uuid) |
Daftar Id persetujuan yang akan didapatkan. |
|
state
|
query |
Status persetujuan. Mengembalikan persetujuan status apa pun jika tidak disediakan |
||
top
|
query |
integer int32 |
Jumlah maksimum persetujuan yang akan didapatkan. |
|
user
|
query |
string array (string) |
Daftar persetujuan Id pengguna yang ditetapkan. Menerima Id pengguna atau deskriptor pengguna. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Approval[] |
operasi berhasil |
Keamanan
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
Nama | Deskripsi |
---|---|
vso.build | Memberikan kemampuan untuk mengakses artefak build, termasuk hasil build, definisi, dan permintaan, dan kemampuan untuk menerima pemberitahuan tentang peristiwa build melalui kait layanan. |
Contoh
Sample Request
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?approvalIds=ee14f612-6838-43c0-b445-db238ef14153,06239b11-a904-43a1-be6a-0d44026bd121&api-version=7.1-preview.1
Sample Response
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
"count": 2,
"value": [
{
"id": "ee14f612-6838-43c0-b445-db238ef14153",
"steps": [],
"status": "pending",
"createdOn": "2020-11-19T08:14:49.58Z",
"lastModifiedOn": "2020-11-19T08:14:49.5793622Z",
"executionOrder": "anyOrder",
"minRequiredApprovers": 1,
"blockedApprovers": [],
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/ee14f612-6838-43c0-b445-db238ef14153"
}
}
},
{
"id": "06239b11-a904-43a1-be6a-0d44026bd121",
"steps": [],
"status": "pending",
"createdOn": "2020-11-19T09:39:35.28Z",
"lastModifiedOn": "2020-11-19T09:39:35.2806001Z",
"executionOrder": "anyOrder",
"minRequiredApprovers": 1,
"blockedApprovers": [],
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/06239b11-a904-43a1-be6a-0d44026bd121"
}
}
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Approval | |
Approval |
Sertakan detail tambahan ini dalam objek yang dikembalikan. |
Approval |
Urutan di mana pemberi izin akan dapat ditindak. |
Approval |
Izin pengguna saat ini untuk objek persetujuan. |
Approval |
Status keseluruhan persetujuan. |
Approval |
Data untuk satu langkah persetujuan. |
Approval |
Data untuk riwayat langkah persetujuan tunggal. |
Identity |
|
Reference |
Kelas untuk mewakili kumpulan tautan referensi REST. |
Approval
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Mendapatkan tautan untuk mengakses objek persetujuan. |
|
blockedApprovers |
Identitas yang tidak diizinkan untuk disetujui. |
|
createdOn |
string |
Tanggal di mana persetujuan dibuat. |
executionOrder |
Urutan di mana pemberi izin akan dapat ditindak. |
|
id |
string |
Pengidentifikasi unik persetujuan. |
instructions |
string |
Instruksi untuk pemberi izin. |
lastModifiedOn |
string |
Tanggal di mana persetujuan terakhir diubah. |
minRequiredApprovers |
integer |
Jumlah minimum pemberi persetujuan yang harus menyetujui seluruh persetujuan untuk dianggap disetujui. |
permissions |
Izin pengguna saat ini untuk objek persetujuan. |
|
status |
Status keseluruhan persetujuan. |
|
steps |
Daftar langkah-langkah yang terkait dengan persetujuan. |
ApprovalDetailsExpandParameter
Sertakan detail tambahan ini dalam objek yang dikembalikan.
Nama | Jenis | Deskripsi |
---|---|---|
none |
string |
Tidak ada properti tambahan. |
permissions |
string |
Sertakan izin pengguna saat ini untuk objek persetujuan. |
steps |
string |
Sertakan langkah-langkah persetujuan yang terkait dengan persetujuan. |
ApprovalExecutionOrder
Urutan di mana pemberi izin akan dapat ditindak.
Nama | Jenis | Deskripsi |
---|---|---|
anyOrder |
string |
Menunjukkan bahwa pemberi persetujuan dapat menyetujui dalam urutan apa pun. |
inSequence |
string |
Menunjukkan bahwa pemberi persetujuan hanya dapat menyetujui dalam urutan berurutan (Urutan di mana mereka ditetapkan). |
ApprovalPermissions
Izin pengguna saat ini untuk objek persetujuan.
Nama | Jenis | Deskripsi |
---|---|---|
none |
string |
|
queueBuild |
string |
|
reassign |
string |
|
resourceAdmin |
string |
|
update |
string |
|
view |
string |
ApprovalStatus
Status keseluruhan persetujuan.
Nama | Jenis | Deskripsi |
---|---|---|
all |
string |
|
approved |
string |
Menunjukkan persetujuan disetujui. |
canceled |
string |
Menunjukkan persetujuan dibatalkan. |
completed |
string |
|
failed |
string |
|
pending |
string |
Menunjukkan persetujuan tertunda. |
rejected |
string |
Menunjukkan persetujuan ditolak. |
skipped |
string |
Menunjukkan persetujuan dilewati. |
timedOut |
string |
Menunjukkan persetujuan telah kehabisan waktu. |
undefined |
string |
|
uninitiated |
string |
Menunjukkan persetujuan tidak diinisiasi. Digunakan dalam kasus dalam urutan eksekusi di mana pemberi izin yang diberikan belum dapat ditindak. |
ApprovalStep
Data untuk satu langkah persetujuan.
Nama | Jenis | Deskripsi |
---|---|---|
actualApprover |
Identitas yang disetujui. |
|
assignedApprover |
Identitas yang harus disetujui. |
|
comment |
string |
Komentar yang terkait dengan langkah ini. |
history |
Riwayat langkah persetujuan |
|
initiatedOn |
string |
Tanda waktu di mana langkah ini dimulai. |
lastModifiedBy |
Identitas tempat langkah ini terakhir diubah. |
|
lastModifiedOn |
string |
Tanda waktu di mana langkah ini terakhir diubah. |
order |
integer |
Urutan di mana pemberi persetujuan diizinkan untuk menyetujui. |
permissions |
Izin pengguna saat ini untuk langkah. |
|
status |
Status saat ini dari langkah ini. |
ApprovalStepHistory
Data untuk riwayat langkah persetujuan tunggal.
Nama | Jenis | Deskripsi |
---|---|---|
assignedTo |
Identitas yang diberi persetujuan ini |
|
comment |
string |
Komentar yang terkait dengan riwayat langkah ini. |
createdBy |
Identitas tempat riwayat langkah ini dibuat. |
|
createdOn |
string |
Tanda waktu di mana riwayat langkah ini dibuat. |
IdentityRef
Nama | Jenis | Deskripsi |
---|---|---|
_links |
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 |
Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "mandiri" kamus IdentityRef "_links" |
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 |
Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links" |
inactive |
boolean |
Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" kamus "_links" GraphUser |
isAadIdentity |
boolean |
Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya |
uniqueName |
string |
Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya |
url |
string |
Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini. |
ReferenceLinks
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. |
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk