Consumers - Get

Odwołanie

Usługa:: Service Hooks

Wersja interfejsu API:: 7.1

Uzyskaj określoną usługę konsumenta. Opcjonalnie odfiltruj akcje konsumentów, które nie obsługują żadnych typów zdarzeń dla określonego wydawcy.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
consumerId	path	True	string	Identyfikator odbiorcy.
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
publisherId	query		string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Consumer	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.work	Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych ze śledzeniem elementów roboczych. Ponadto umożliwia wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.
vso.build	Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.
vso.code	Przyznaje możliwość odczytywania kodu źródłowego i metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również wyszukiwanie kodu i otrzymywanie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Przykłady

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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": []
    }
  ]
}

Definicje

Nazwa	Opis
AuthenticationType	Pobiera lub ustawia typ uwierzytelniania tego użytkownika.
Consumer	Definiuje kontrakt danych odbiorcy.
ConsumerAction	Definiuje kontrakt danych akcji konsumenta.
ExternalConfigurationDescriptor	Opisuje sposób konfigurowania subskrypcji zarządzanej zewnętrznie.
InputDataType	Pobiera lub ustawia typ danych w celu zweryfikowania.
InputDescriptor	Opisuje dane wejściowe dla subskrypcji.
InputMode	Tryb, w którym należy wprowadzić wartość tych danych wejściowych
InputValidation	Opisuje, jakie wartości są prawidłowe dla danych wejściowych subskrypcji
InputValue	Informacje o pojedynczej wartości dla danych wejściowych
InputValues	Informacje o możliwych/dozwolonych wartościach dla danych wejściowych danej subskrypcji
InputValuesError	Informacje o błędzie związane z wartością wejściową subskrypcji.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.

AuthenticationType

Wyliczanie

Pobiera lub ustawia typ uwierzytelniania tego użytkownika.

Wartość	Opis
external	Uwierzytelnianie skonfigurowane zewnętrznie.
none	Nie jest wymagane uwierzytelnianie.
oAuth	Uwierzytelnianie OAuth.

Consumer

Objekt

Definiuje kontrakt danych odbiorcy.

Nazwa	Typ	Opis
_links	ReferenceLinks	Łącza referencyjne
actions	ConsumerAction[]	Pobiera akcje tego konsumenta.
authenticationType	AuthenticationType	Pobiera lub ustawia typ uwierzytelniania tego użytkownika.
description	string	Pobiera lub ustawia zlokalizowany opis tego konsumenta.
externalConfiguration	ExternalConfigurationDescriptor	Nie ma wartości null tylko wtedy, gdy subskrypcje dla tego konsumenta są konfigurowane zewnętrznie.
id	string	Pobiera lub ustawia identyfikator tego użytkownika.
imageUrl	string	Pobiera lub ustawia adres URL obrazu tego użytkownika, jeśli istnieje.
informationUrl	string	Pobiera lub ustawia adres URL informacji tego użytkownika, jeśli istnieje.
inputDescriptors	InputDescriptor[]	Pobiera lub ustawia deskryptory wejściowe tego odbiorcy.
name	string	Pobiera lub ustawia zlokalizowaną nazwę tego konsumenta.
url	string	Adres URL dla tego zasobu

ConsumerAction

Objekt

Definiuje kontrakt danych akcji konsumenta.

Nazwa	Typ	Opis
_links	ReferenceLinks	Łącza referencyjne
allowResourceVersionOverride	boolean	Pobiera lub ustawia flagę wskazującą, czy można zastąpić wersję zasobu podczas tworzenia lub edytowania subskrypcji.
consumerId	string	Pobiera lub ustawia identyfikator odbiorcy, do którego należy ta akcja.
description	string	Pobiera lub ustawia zlokalizowany opis tej akcji.
id	string	Pobiera lub ustawia identyfikator tej akcji.
inputDescriptors	InputDescriptor[]	Pobiera lub ustawia deskryptory wejściowe tej akcji.
name	string	Pobiera lub ustawia zlokalizowaną nazwę tej akcji.
supportedEventTypes	string[]	Pobiera lub ustawia obsługiwane identyfikatory zdarzeń tej akcji.
supportedResourceVersions	object	Pobiera lub ustawia obsługiwane wersje zasobów tej akcji.
url	string	Adres URL dla tego zasobu

ExternalConfigurationDescriptor

Objekt

Opisuje sposób konfigurowania subskrypcji zarządzanej zewnętrznie.

Nazwa	Typ	Opis
createSubscriptionUrl	string	Adres URL witryny do utworzenia tego typu subskrypcji.
editSubscriptionPropertyName	string	Nazwa właściwości wejściowej, która zawiera adres URL do edycji subskrypcji.
hostedOnly	boolean	Prawda, jeśli konfiguracja zewnętrzna ma zastosowanie tylko do hostowanych.

InputDataType

Wyliczanie

Pobiera lub ustawia typ danych w celu zweryfikowania.

Wartość	Opis
boolean	Reprezentuje wartość true lub false.
guid	Reprezentuje identyfikator GUID.
none	Nie określono żadnego typu danych.
number	Reprezentuje wartość liczbową.
string	Reprezentuje wartość tekstową.
uri	Reprezentuje identyfikator URI.

InputDescriptor

Objekt

Opisuje dane wejściowe dla subskrypcji.

Nazwa	Typ	Opis
dependencyInputIds	string[]	Identyfikatory wszystkich danych wejściowych, od których zależy wartość tego danych wejściowych.
description	string	Opis używanych danych wejściowych
groupName	string	Zlokalizowana nazwa grupy, do której należy ten element wejściowy i może być wyświetlana jako nagłówek kontenera, który będzie zawierać wszystkie dane wejściowe w grupie.
hasDynamicValueInformation	boolean	Jeśli wartość true, informacje o wartości dla tych danych wejściowych są dynamiczne i powinny być pobierane po zmianie wartości danych wejściowych zależności.
id	string	Identyfikator danych wejściowych subskrypcji
inputMode	InputMode	Tryb, w którym należy wprowadzić wartość tych danych wejściowych
isConfidential	boolean	Pobiera informacje o tym, czy dane wejściowe są poufne, takie jak hasło, czy klucz aplikacji
name	string	Zlokalizowana nazwa, która może być wyświetlana jako etykieta danych wejściowych subskrypcji
properties	object	Właściwości niestandardowe dla danych wejściowych, które mogą być używane przez dostawcę usług
type	string	Podstawowy typ danych dla wartości wejściowej. Po określeniu tej wartości parametr InputMode, Validation i Values są opcjonalne.
useInDefaultDescription	boolean	Pobiera, czy te dane wejściowe są uwzględniane w domyślnym opisie wygenerowanej akcji.
validation	InputValidation	Informacje używane do sprawdzania poprawności wartości danych wejściowych
valueHint	string	Wskazówka dotycząca wartości wejściowej. Może być używany w interfejsie użytkownika jako symbol zastępczy danych wejściowych.
values	InputValues	Informacje o możliwych wartościach dla tych danych wejściowych

InputMode

Wyliczanie

Tryb, w którym należy wprowadzić wartość tych danych wejściowych

Wartość	Opis
checkBox	Pole wyboru powinno być wyświetlane (dla wartości true/false)
combo	Powinna zostać wyświetlona kontrolka select/combo
none	Te dane wejściowe nie powinny być wyświetlane w interfejsie użytkownika
passwordBox	Powinno zostać wyświetlone pole wprowadzania hasła
radioButtons	Przyciski radiowe powinny być wyświetlane
textArea	Powinien zostać wyświetlony obszar tekstowy wielowierszowy
textBox	Powinno zostać wyświetlone pole tekstowe wejściowe

InputValidation

Objekt

Opisuje, jakie wartości są prawidłowe dla danych wejściowych subskrypcji

Nazwa	Typ	Opis
dataType	InputDataType	Pobiera lub ustawia typ danych w celu zweryfikowania.
isRequired	boolean	Pobiera lub ustawia, jeśli jest to wymagane pole.
maxLength	integer (int32)	Pobiera lub ustawia maksymalną długość tego deskryptora.
maxValue	string (decimal)	Pobiera lub ustawia minimalną wartość dla tego deskryptora.
minLength	integer (int32)	Pobiera lub ustawia minimalną długość tego deskryptora.
minValue	string (decimal)	Pobiera lub ustawia minimalną wartość dla tego deskryptora.
pattern	string	Pobiera lub ustawia wzorzec w celu zweryfikowania.
patternMismatchErrorMessage	string	Pobiera lub ustawia błąd w przypadku niezgodności wzorca.

InputValue

Objekt

Informacje o pojedynczej wartości dla danych wejściowych

Nazwa	Typ	Opis
data	object	Wszelkie inne dane dotyczące tych danych wejściowych
displayValue	string	Tekst do wyświetlenia tej wartości
value	string	Wartość do przechowywania dla tych danych wejściowych

InputValues

Objekt

Informacje o możliwych/dozwolonych wartościach dla danych wejściowych danej subskrypcji

Nazwa	Typ	Opis
defaultValue	string	Wartość domyślna do użycia dla tych danych wejściowych
error	InputValuesError	Napotkano błędy podczas obliczania wartości dynamicznych.
inputId	string	Identyfikator danych wejściowych
isDisabled	boolean	Jeśli te dane wejściowe zostaną wyłączone
isLimitedToPossibleValues	boolean	Jeśli wartość powinna być ograniczona do jednej z wartości w wartościach PossibleValues (True) lub są wartościami w parametrach PossibleValues tylko sugestią (Fałsz)
isReadOnly	boolean	Jeśli te dane wejściowe mają być tylko do odczytu
possibleValues	InputValue[]	Możliwe wartości, które mogą przyjmować te dane wejściowe

InputValuesError

Objekt

Informacje o błędzie związane z wartością wejściową subskrypcji.

Nazwa	Typ	Opis
message	string	Komunikat o błędzie.

ReferenceLinks

Objekt

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

Udostępnij przez

Consumers - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AuthenticationType

Consumer

ConsumerAction

ExternalConfigurationDescriptor

InputDataType

InputDescriptor

InputMode

InputValidation

InputValue

InputValues

InputValuesError

ReferenceLinks