Publishers - Get
Mendapatkan penerbit hook layanan tertentu.
GET https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}?api-version=7.1-preview.1Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Nama organisasi Azure DevOps. |
|
publisher
|
path | True |
string |
ID untuk penerbit. |
|
api-version
|
query | True |
string |
Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini. |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 OK |
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.work | Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur area dan iterasi, dan metadata terkait pelacakan item kerja lainnya. Juga memberikan kemampuan untuk menjalankan kueri, mencari item kerja, dan menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan. |
| 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. |
| vso.code | Memberikan kemampuan untuk membaca kode sumber dan metadata tentang penerapan, set perubahan, cabang, dan artefak kontrol versi lainnya. Juga memberikan kemampuan untuk mencari kode dan mendapatkan pemberitahuan tentang peristiwa kontrol versi melalui kait layanan. |
Definisi
| Nama | Deskripsi |
|---|---|
|
Event |
Menjelaskan jenis peristiwa |
|
Input |
Mendapatkan atau mengatur jenis data untuk divalidasi. |
|
Input |
Menjelaskan input untuk langganan. |
|
Input |
Mode di mana nilai input ini harus dimasukkan |
|
Input |
Menjelaskan nilai apa yang valid untuk input langganan |
|
Input |
Informasi tentang satu nilai untuk input |
|
Input |
Informasi tentang nilai yang mungkin/diizinkan untuk input langganan tertentu |
|
Input |
Informasi kesalahan yang terkait dengan nilai input langganan. |
| Publisher |
Menentukan kontrak data penerbit peristiwa. |
|
Reference |
Kelas untuk mewakili kumpulan tautan referensi REST. |
EventTypeDescriptor
Menjelaskan jenis peristiwa
| Nama | Jenis | Deskripsi |
|---|---|---|
| description |
string |
Deskripsi yang dilokalkan dari jenis peristiwa |
| id |
string |
Id unik untuk jenis peristiwa |
| inputDescriptors |
Input khusus peristiwa |
|
| name |
string |
Nama ramah yang dilokalkan untuk jenis peristiwa |
| publisherId |
string |
Id unik untuk penerbit jenis kejadian ini |
| supportedResourceVersions |
string[] |
Versi yang didukung untuk payload sumber daya peristiwa. |
| url |
string |
Url untuk sumber daya ini |
InputDataType
Mendapatkan atau mengatur jenis data untuk divalidasi.
| Nama | Jenis | Deskripsi |
|---|---|---|
| boolean |
string |
Mewakili nilai true atau false. |
| guid |
string |
Mewakili Guid. |
| none |
string |
Tidak ada jenis data yang ditentukan. |
| number |
string |
Mewakili nilai numerik. |
| string |
string |
Mewakili nilai tekstual. |
| uri |
string |
Mewakili URI. |
InputDescriptor
Menjelaskan input untuk langganan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| dependencyInputIds |
string[] |
Id dari semua input yang bergantung pada nilai input ini. |
| description |
string |
Deskripsi untuk apa input ini digunakan |
| groupName |
string |
Nama yang dilokalkan grup tempat input ini berada dan dapat ditampilkan sebagai header untuk kontainer yang akan menyertakan semua input dalam grup. |
| hasDynamicValueInformation |
boolean |
Jika true, informasi nilai untuk input ini bersifat dinamis dan harus diambil ketika nilai input dependensi berubah. |
| id |
string |
Pengidentifikasi untuk input langganan |
| inputMode |
Mode di mana nilai input ini harus dimasukkan |
|
| isConfidential |
boolean |
Mendapatkan apakah input ini bersifat rahasia, seperti untuk kata sandi atau kunci aplikasi |
| name |
string |
Nama yang dilokalkan yang dapat ditampilkan sebagai label untuk input langganan |
| properties |
object |
Properti kustom untuk input yang dapat digunakan oleh penyedia layanan |
| type |
string |
Jenis data yang mendasar untuk nilai input. Ketika nilai ini ditentukan, InputMode, Validasi, dan Nilai bersifat opsional. |
| useInDefaultDescription |
boolean |
Mendapatkan apakah input ini disertakan dalam deskripsi tindakan yang dihasilkan secara default. |
| validation |
Informasi yang digunakan untuk memvalidasi nilai input ini |
|
| valueHint |
string |
Petunjuk untuk nilai input. Ini dapat digunakan di UI sebagai tempat penampung input. |
| values |
Informasi tentang kemungkinan nilai untuk input ini |
InputMode
Mode di mana nilai input ini harus dimasukkan
| Nama | Jenis | Deskripsi |
|---|---|---|
| checkBox |
string |
Kotak centang harus ditampilkan(untuk nilai true/false) |
| combo |
string |
Kontrol pilih/kombo harus ditampilkan |
| none |
string |
Input ini tidak boleh ditampilkan di UI |
| passwordBox |
string |
Kotak input kata sandi harus ditampilkan |
| radioButtons |
string |
Tombol radio harus ditampilkan |
| textArea |
string |
Area teks multibaris harus ditampilkan |
| textBox |
string |
Kotak teks input harus ditampilkan |
InputValidation
Menjelaskan nilai apa yang valid untuk input langganan
| Nama | Jenis | Deskripsi |
|---|---|---|
| dataType |
Mendapatkan atau mengatur jenis data untuk divalidasi. |
|
| isRequired |
boolean |
Mendapatkan atau mengatur jika ini adalah bidang yang diperlukan. |
| maxLength |
integer |
Mendapatkan atau mengatur panjang maksimum deskriptor ini. |
| maxValue |
string |
Mendapatkan atau menetapkan nilai minimum untuk deskriptor ini. |
| minLength |
integer |
Mendapatkan atau mengatur panjang minimum deskriptor ini. |
| minValue |
string |
Mendapatkan atau menetapkan nilai minimum untuk deskriptor ini. |
| pattern |
string |
Mendapatkan atau mengatur pola untuk divalidasi. |
| patternMismatchErrorMessage |
string |
Mendapatkan atau mengatur kesalahan pada ketidakcocokan pola. |
InputValue
Informasi tentang satu nilai untuk input
| Nama | Jenis | Deskripsi |
|---|---|---|
| data |
object |
Data lain tentang input ini |
| displayValue |
string |
Teks yang ditampilkan untuk tampilan nilai ini |
| value |
string |
Nilai yang akan disimpan untuk input ini |
InputValues
Informasi tentang nilai yang mungkin/diizinkan untuk input langganan tertentu
| Nama | Jenis | Deskripsi |
|---|---|---|
| defaultValue |
string |
Nilai default yang digunakan untuk input ini |
| error |
Kesalahan yang ditemui saat menghitung nilai dinamis. |
|
| inputId |
string |
Id input |
| isDisabled |
boolean |
Jika input ini dinonaktifkan |
| isLimitedToPossibleValues |
boolean |
Jika nilai dibatasi ke salah satu nilai dalam PossibleValues (True) atau merupakan nilai dalam PossibleValues hanya saran (False) |
| isReadOnly |
boolean |
Jika input ini dibuat baca-saja |
| possibleValues |
Kemungkinan nilai yang dapat diambil input ini |
InputValuesError
Informasi kesalahan yang terkait dengan nilai input langganan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| message |
string |
Pesan kesalahan. |
Publisher
Menentukan kontrak data penerbit peristiwa.
| Nama | Jenis | Deskripsi |
|---|---|---|
| _links |
Tautan Referensi |
|
| description |
string |
Mendapatkan deskripsi penerbit yang dilokalkan ini. |
| id |
string |
Mendapatkan pengidentifikasi penerbit ini. |
| inputDescriptors |
Input khusus penerbit |
|
| name |
string |
Mendapatkan nama penerbit yang dilokalkan ini. |
| serviceInstanceType |
string |
Jenis instans layanan penerbit pihak pertama. |
| supportedEvents |
Mendapatkan jenis peristiwa yang didukung penerbit ini. |
|
| url |
string |
Url untuk sumber daya ini |
ReferenceLinks
Kelas untuk mewakili kumpulan tautan referensi REST.
| Nama | Jenis | Deskripsi |
|---|---|---|
| links |
object |
Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja. |