Consumers - Get Consumer Action

Referenz

Dienst:: Service Hooks

API-Version:: 7.1

Rufen Sie Details zu einer bestimmten Verbraucheraktion ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
consumerActionId	path	True	string	ID für eine consumerActionId.
consumerId	path	True	string	ID für einen Verbraucher.
organization	path	True	string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
publisherId	query		string

Antworten

Name	Typ	Beschreibung
200 OK	ConsumerAction	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.work	Gewährt die Möglichkeit, Arbeitsaufgaben, Abfragen, Boards, Flächen- und Iterationspfade und andere Metadaten zur Nachverfolgung von Arbeitsaufgaben zu lesen. Gewährt außerdem die Möglichkeit, Abfragen auszuführen, Arbeitsaufgaben zu durchsuchen und Benachrichtigungen über Arbeitsaufgabenereignisse über Dienst-Hooks zu erhalten.
vso.build	Gewährt die Möglichkeit, auf Buildartefakte zuzugreifen, einschließlich Buildergebnissen, Definitionen und Anforderungen sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Dienst-Hooks zu empfangen.
vso.code	Gewährt die Möglichkeit, Quellcode und Metadaten zu Commits, Changesets, Verzweigungen und anderen Versionskontrollartefakten zu lesen. Gewährt außerdem die Möglichkeit, Code zu durchsuchen und über Dienst-Hooks über Versionssteuerungsereignisse benachrichtigt zu werden.

Beispiele

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
ConsumerAction	Definiert den Datenvertrag einer Verbraucheraktion.
InputDataType	Ruft den zu überprüfenden Datentyp ab oder legt diesen fest.
InputDescriptor	Beschreibt eine Eingabe für Abonnements.
InputMode	Modus, in den der Wert dieser Eingabe eingegeben werden soll
InputValidation	Beschreibt, welche Werte für eine Abonnementeingabe gültig sind.
InputValue	Informationen zu einem einzelnen Wert für eine Eingabe
InputValues	Informationen zu den möglichen/zulässigen Werten für eine bestimmte Abonnementeingabe
InputValuesError	Fehlerinformationen im Zusammenhang mit einem Abonnementeingabewert.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

ConsumerAction

Objekt

Definiert den Datenvertrag einer Verbraucheraktion.

Name	Typ	Beschreibung
_links	ReferenceLinks	Referenzlinks
allowResourceVersionOverride	boolean	Dient zum Abrufen oder Festlegen des Flags, das angibt, ob die Ressourcenversion beim Erstellen oder Bearbeiten eines Abonnements außer Kraft gesetzt werden kann.
consumerId	string	Dient zum Abrufen oder Festlegen des Bezeichners des Consumers, zu dem diese Aktion gehört.
description	string	Ruft die lokalisierte Beschreibung dieser Aktion ab oder legt sie fest.
id	string	Dient zum Abrufen oder Festlegen des Bezeichners dieser Aktion.
inputDescriptors	InputDescriptor[]	Ruft die Eingabedeskriptoren dieser Aktion ab oder legt sie fest.
name	string	Ruft den lokalisierten Namen dieser Aktion ab oder legt diesen fest.
supportedEventTypes	string[]	Ruft die unterstützten Ereignisbezeichner dieser Aktion ab oder legt sie fest.
supportedResourceVersions	object	Ruft die unterstützten Ressourcenversionen dieser Aktion ab oder legt sie fest.
url	string	Die URL für diese Ressource

InputDataType

Enumeration

Ruft den zu überprüfenden Datentyp ab oder legt diesen fest.

Wert	Beschreibung
boolean	Stellt einen Wert von "true" oder "false" dar.
guid	Stellt eine GUID dar.
none	Es wird kein Datentyp angegeben.
number	Stellt einen numerischen Wert dar.
string	Stellt einen Textwert dar.
uri	Stellt einen URI dar.

InputDescriptor

Objekt

Beschreibt eine Eingabe für Abonnements.

Name	Typ	Beschreibung
dependencyInputIds	string[]	Die IDs aller Eingaben, von denen der Wert dieser Eingabe abhängig ist.
description	string	Beschreibung, für welche Eingabe diese Eingabe verwendet wird
groupName	string	Der lokalisierte Name der Gruppe, zu der diese Eingabe gehört, und kann als Header für den Container angezeigt werden, der alle Eingaben in der Gruppe enthält.
hasDynamicValueInformation	boolean	Wenn true, sind die Wertinformationen für diese Eingabe dynamisch und sollten abgerufen werden, wenn sich der Wert von Abhängigkeitseingaben ändert.
id	string	Bezeichner für die Abonnementeingabe
inputMode	InputMode	Modus, in den der Wert dieser Eingabe eingegeben werden soll
isConfidential	boolean	Ruft ab, ob diese Eingabe vertraulich ist, z. B. für ein Kennwort oder einen Anwendungsschlüssel
name	string	Lokalisierter Name, der als Bezeichnung für die Abonnementeingabe angezeigt werden kann
properties	object	Benutzerdefinierte Eigenschaften für die Eingabe, die vom Dienstanbieter verwendet werden kann
type	string	Zugrunde liegender Datentyp für den Eingabewert. Wenn dieser Wert angegeben ist, sind InputMode, Validation und Values optional.
useInDefaultDescription	boolean	Ruft ab, ob diese Eingabe in der standardmäßig generierten Aktionsbeschreibung enthalten ist.
validation	InputValidation	Informationen zur Überprüfung des Werts dieser Eingabe
valueHint	string	Ein Hinweis für den Eingabewert. Sie kann in der Benutzeroberfläche als Eingabeplatzhalter verwendet werden.
values	InputValues	Informationen zu möglichen Werten für diese Eingabe

InputMode

Enumeration

Modus, in den der Wert dieser Eingabe eingegeben werden soll

Wert	Beschreibung
checkBox	Das Kontrollkästchen sollte angezeigt werden(für true/false-Werte)
combo	Ein Auswahl-/Kombinationssteuerelement sollte angezeigt werden.
none	Diese Eingabe sollte nicht in der Benutzeroberfläche angezeigt werden.
passwordBox	Ein Kennworteingabefeld sollte angezeigt werden.
radioButtons	Optionsfelder sollten angezeigt werden
textArea	Ein mehrzeiliges Textbereich sollte angezeigt werden.
textBox	Ein Eingabetextfeld sollte angezeigt werden.

InputValidation

Objekt

Beschreibt, welche Werte für eine Abonnementeingabe gültig sind.

Name	Typ	Beschreibung
dataType	InputDataType	Ruft den zu überprüfenden Datentyp ab oder legt diesen fest.
isRequired	boolean	Ruft ab oder legt fest, ob dies ein erforderliches Feld ist.
maxLength	integer (int32)	Dient zum Abrufen oder Festlegen der maximalen Länge dieses Deskriptors.
maxValue	string (decimal)	Ruft den Minimalwert für diesen Deskriptor ab oder legt diesen fest.
minLength	integer (int32)	Ruft die Mindestlänge dieses Deskriptors ab oder legt sie fest.
minValue	string (decimal)	Ruft den Minimalwert für diesen Deskriptor ab oder legt diesen fest.
pattern	string	Ruft das zu überprüfende Muster ab oder legt es fest.
patternMismatchErrorMessage	string	Ruft den Fehler bei musterkonflikten ab oder legt den Fehler fest.

InputValue

Objekt

Informationen zu einem einzelnen Wert für eine Eingabe

Name	Typ	Beschreibung
data	object	Alle anderen Daten zu dieser Eingabe
displayValue	string	Der Text, der für die Anzeige dieses Werts angezeigt werden soll
value	string	Der wert, der für diese Eingabe gespeichert werden soll

InputValues

Objekt

Informationen zu den möglichen/zulässigen Werten für eine bestimmte Abonnementeingabe

Name	Typ	Beschreibung
defaultValue	string	Der Standardwert, der für diese Eingabe verwendet werden soll
error	InputValuesError	Fehler beim Berechnen dynamischer Werte.
inputId	string	Die ID der Eingabe
isDisabled	boolean	Sollte diese Eingabe deaktiviert sein
isLimitedToPossibleValues	boolean	Sollte der Wert auf einen der Werte in den PossibleValues (True) beschränkt werden oder sind die Werte in PossibleValues nur ein Vorschlag (False)
isReadOnly	boolean	Sollte diese Eingabe schreibgeschützt gemacht werden
possibleValues	InputValue[]	Mögliche Werte, die diese Eingabe annehmen kann

InputValuesError

Objekt

Fehlerinformationen im Zusammenhang mit einem Abonnementeingabewert.

Name	Typ	Beschreibung
message	string	Die Fehlermeldung.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Freigeben über

Consumers - Get Consumer Action

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConsumerAction

InputDataType

InputDescriptor

InputMode

InputValidation

InputValue

InputValues

InputValuesError

ReferenceLinks