Approvals - Update

Referensi

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Perbarui persetujuan.

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?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.

Isi Permintaan

Nama	Jenis	Deskripsi
body	ApprovalUpdateParameters[]

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_execute	Memberikan kemampuan untuk mengakses artefak build, termasuk hasil build, definisi, dan permintaan, dan kemampuan untuk mengantre build, memperbarui properti build, dan kemampuan untuk menerima pemberitahuan tentang peristiwa build melalui hook layanan.
vso.pipelineresources_use	Memberikan kemampuan untuk menyetujui permintaan alur untuk menggunakan sumber daya yang dilindungi: kumpulan agen, lingkungan, antrean, repositori, file aman, koneksi layanan, dan grup variabel

Contoh

Sample Request

HTTP

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/approvals?api-version=7.1-preview.1

[
  {
    "approvalId": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
    "comment": "Approving",
    "status": "approved"
  }
]

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "count": 1,
  "value": [
    {
      "id": "aab27959-a5be-4ee3-97ca-f19b3602cd2f",
      "steps": [
        {
          "assignedApprover": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "actualApprover": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "status": "approved",
          "comment": "Approving",
          "lastModifiedOn": "2020-11-19T09:57:54.252505Z",
          "order": 1,
          "lastModifiedBy": {
            "displayName": "User Name",
            "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
            "uniqueName": "uniqueName",
            "descriptor": "Descriptor"
          },
          "initiatedOn": "2020-11-19T09:51:16.7045043Z",
          "history": []
        }
      ],
      "status": "approved",
      "createdOn": "2020-11-19T09:51:16.703Z",
      "lastModifiedOn": "2020-11-19T09:57:54.252505Z",
      "executionOrder": "anyOrder",
      "minRequiredApprovers": 1,
      "blockedApprovers": [],
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/approvals/aab27959-a5be-4ee3-97ca-f19b3602cd2f"
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
Approval
ApprovalExecutionOrder	Urutan di mana pemberi izin akan dapat ditindak.
ApprovalPermissions	Izin pengguna saat ini untuk objek persetujuan.
ApprovalStatus	Status keseluruhan persetujuan.
ApprovalStep	Data untuk satu langkah persetujuan.
ApprovalStepHistory	Data untuk riwayat langkah persetujuan tunggal.
ApprovalUpdateParameters	Data untuk memperbarui objek persetujuan atau langkah individualnya.
IdentityRef
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.

Approval

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Mendapatkan tautan untuk mengakses objek persetujuan.
blockedApprovers	IdentityRef[]	Identitas yang tidak diizinkan untuk disetujui.
createdOn	string	Tanggal di mana persetujuan dibuat.
executionOrder	ApprovalExecutionOrder	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	ApprovalPermissions	Izin pengguna saat ini untuk objek persetujuan.
status	ApprovalStatus	Status keseluruhan persetujuan.
steps	ApprovalStep[]	Daftar langkah-langkah 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	IdentityRef	Identitas yang disetujui.
assignedApprover	IdentityRef	Identitas yang harus disetujui.
comment	string	Komentar yang terkait dengan langkah ini.
history	ApprovalStepHistory[]	Riwayat langkah persetujuan
initiatedOn	string	Tanda waktu di mana langkah ini dimulai.
lastModifiedBy	IdentityRef	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	ApprovalPermissions	Izin pengguna saat ini untuk langkah.
status	ApprovalStatus	Status saat ini dari langkah ini.

ApprovalStepHistory

Data untuk riwayat langkah persetujuan tunggal.

Nama	Jenis	Deskripsi
assignedTo	IdentityRef	Identitas yang diberi persetujuan ini
comment	string	Komentar yang terkait dengan riwayat langkah ini.
createdBy	IdentityRef	Identitas tempat riwayat langkah ini dibuat.
createdOn	string	Tanda waktu di mana riwayat langkah ini dibuat.

ApprovalUpdateParameters

Data untuk memperbarui objek persetujuan atau langkah individualnya.

Nama	Jenis	Deskripsi
approvalId	string	ID persetujuan yang akan diperbarui.
assignedApprover	IdentityRef	Pemberi persetujuan saat ini.
comment	string	Mendapatkan atau mengatur komentar.
reassignTo	IdentityRef	Pemberi Izin yang Ditetapkan Kembali.
status	ApprovalStatus	Mendapatkan atau menetapkan status.

IdentityRef

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

Bagikan melalui