Consumers - Get

Referensi

Service:: Service Hooks

API Version:: 7.1-preview.1

Dapatkan layanan konsumen tertentu. Secara opsional memfilter tindakan konsumen yang tidak mendukung jenis peristiwa apa pun untuk penerbit yang ditentukan.

GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?publisherId={publisherId}&api-version=7.1-preview.1

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
consumerId	path	True	string	ID untuk konsumen.
organization	path	True	string	Nama organisasi Azure DevOps.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.
publisherId	query		string

Respons

Nama	Jenis	Deskripsi
200 OK	Consumer	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.work	Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur perulangan dan area, serta 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 hook layanan.

Contoh

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk?api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "id": "zendesk",
  "url": "https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk",
  "name": "Zendesk",
  "description": "Zendesk is a SaaS suite that offers help desk ticketing, issue tracking, and customer service support.",
  "imageUrl": "",
  "informationUrl": "http://go.microsoft.com/fwlink/?LinkID=396756",
  "authenticationType": "external",
  "inputDescriptors": [
    {
      "id": "accountName",
      "name": "Account name",
      "description": "Zendesk account name like https://<account name>.zendesk.com",
      "inputMode": "textBox",
      "isConfidential": false,
      "useInDefaultDescription": true,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "pattern": "^([A-Za-z0-9][A-Za-z0-9\\-]{0,61}[A-Za-z0-9]|[A-Za-z0-9]{1,63})$",
        "maxLength": 63
      }
    },
    {
      "id": "username",
      "name": "User name",
      "description": "The Zendesk user name of a user who will update tickets",
      "inputMode": "textBox",
      "isConfidential": false,
      "useInDefaultDescription": false,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "pattern": "^.+\\@.+\\..+$",
        "maxLength": 254
      }
    },
    {
      "id": "apiToken",
      "name": "API token",
      "description": "The Zendesk API token (can be found in Zendesk app in Admin > Channels > API)",
      "inputMode": "passwordBox",
      "isConfidential": true,
      "useInDefaultDescription": false,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "maxLength": 100
      }
    }
  ],
  "actions": [
    {
      "id": "createPrivateComment",
      "consumerId": "zendesk",
      "url": "https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk/actions/createPrivateComment",
      "name": "Create a private comment in a ticket",
      "description": "Create a private comment in a ticket. <a href='http://go.microsoft.com/fwlink/?LinkId=396756'>Learn more.</a>",
      "supportedEventTypes": [
        "workitem.commented"
      ],
      "supportedResourceVersions": {
        "workitem.commented": [
          "1.0-preview.1"
        ]
      },
      "inputDescriptors": []
    }
  ]
}

Definisi

Nama	Deskripsi
AuthenticationType	Mendapatkan atau mengatur jenis autentikasi konsumen ini.
Consumer	Menentukan kontrak data konsumen.
ConsumerAction	Menentukan kontrak data tindakan konsumen.
ExternalConfigurationDescriptor	Menjelaskan cara mengonfigurasi langganan yang dikelola secara eksternal.
InputDataType	Mendapatkan atau mengatur jenis data untuk divalidasi.
InputDescriptor	Menjelaskan input untuk langganan.
InputMode	Mode di mana nilai input ini harus dimasukkan
InputValidation	Menjelaskan nilai apa yang valid untuk input langganan
InputValue	Informasi tentang satu nilai untuk input
InputValues	Informasi tentang nilai yang mungkin/diizinkan untuk input langganan tertentu
InputValuesError	Informasi kesalahan yang terkait dengan nilai input langganan.
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.

AuthenticationType

Mendapatkan atau mengatur jenis autentikasi konsumen ini.

Nama	Jenis	Deskripsi
external	string	Autentikasi yang dikonfigurasi secara eksternal.
none	string	Tidak diperlukan autentikasi.
oAuth	string	Autentikasi OAuth.

Consumer

Menentukan kontrak data konsumen.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Tautan Referensi
actions	ConsumerAction[]	Mendapatkan tindakan konsumen ini.
authenticationType	AuthenticationType	Mendapatkan atau mengatur jenis autentikasi konsumen ini.
description	string	Mendapatkan atau menetapkan deskripsi konsumen yang dilokalkan ini.
externalConfiguration	ExternalConfigurationDescriptor	Tidak null hanya jika langganan untuk konsumen ini dikonfigurasi secara eksternal.
id	string	Mendapatkan atau mengatur pengidentifikasi konsumen ini.
imageUrl	string	Mendapatkan atau mengatur URL gambar konsumen ini, jika ada.
informationUrl	string	Mendapatkan atau mengatur URL informasi konsumen ini, jika ada.
inputDescriptors	InputDescriptor[]	Mendapatkan atau mengatur deskriptor input konsumen ini.
name	string	Mendapatkan atau menetapkan nama konsumen yang dilokalkan ini.
url	string	Url untuk sumber daya ini

ConsumerAction

Menentukan kontrak data tindakan konsumen.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Tautan Referensi
allowResourceVersionOverride	boolean	Mendapatkan atau mengatur bendera yang menunjukkan apakah versi sumber daya dapat ditimpa saat membuat atau mengedit langganan.
consumerId	string	Mendapatkan atau mengatur pengidentifikasi konsumen tempat tindakan ini berada.
description	string	Mendapatkan atau mengatur deskripsi tindakan ini yang dilokalkan.
id	string	Mendapatkan atau mengatur pengidentifikasi tindakan ini.
inputDescriptors	InputDescriptor[]	Mendapatkan atau mengatur deskriptor input tindakan ini.
name	string	Mendapatkan atau mengatur nama tindakan ini yang dilokalkan.
supportedEventTypes	string[]	Mendapatkan atau mengatur pengidentifikasi peristiwa yang didukung tindakan ini.
supportedResourceVersions	object	Mendapatkan atau mengatur versi sumber daya yang didukung tindakan ini.
url	string	Url untuk sumber daya ini

ExternalConfigurationDescriptor

Menjelaskan cara mengonfigurasi langganan yang dikelola secara eksternal.

Nama	Jenis	Deskripsi
createSubscriptionUrl	string	Url situs untuk membuat jenis langganan ini.
editSubscriptionPropertyName	string	Nama properti input yang berisi URL untuk mengedit langganan.
hostedOnly	boolean	True jika konfigurasi eksternal hanya berlaku untuk dihosting.

InputDataType

Mendapatkan atau mengatur jenis data untuk divalidasi.

Nama	Jenis	Deskripsi
boolean	string	Mewakili nilai benar atau salah.
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 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	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	InputValidation	Informasi yang digunakan untuk memvalidasi nilai input ini
valueHint	string	Petunjuk untuk nilai input. Ini dapat digunakan di UI sebagai tempat penampung input.
values	InputValues	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	InputDataType	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	InputValuesError	Terjadi kesalahan saat menghitung nilai dinamis.
inputId	string	Id input
isDisabled	boolean	Jika input ini dinonaktifkan
isLimitedToPossibleValues	boolean	Jika nilai dibatasi untuk salah satu nilai dalam PossibleValues (True) atau adalah nilai dalam PossibleValues hanya saran (False)
isReadOnly	boolean	Jika input ini dibuat baca-saja
possibleValues	InputValue[]	Kemungkinan nilai yang dapat diambil input ini

InputValuesError

Informasi kesalahan yang terkait dengan nilai input langganan.

Nama	Jenis	Deskripsi
message	string	Pesan kesalahan.

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.

Bagikan melalui