Publishers - Query Publishers

Referenz

Dienst:: Service Hooks

API-Version:: 7.1-preview.1

Abfrage für Service Hook-Herausgeber.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
publisherIds	string[]	Optionale Liste der Herausgeber-IDs zum Einschränken der Ergebnisse auf
publisherInputs	object	Filtern nach Herausgebereingaben
results	Publisher[]	Ergebnisse der Abfrage

Antworten

Name	Typ	Beschreibung
200 OK	PublishersQuery	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	Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Bietet außerdem die Möglichkeit, Abfragen auszuführen, Arbeitselemente zu durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthooks zu erhalten.
vso.build	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Diensthooks zu empfangen.
vso.code	Ermöglicht das Lesen von Quellcode und Metadaten zu Commits, Changesets, Branches und anderen Versionskontrollartefakten. Bietet außerdem die Möglichkeit, Code zu suchen und über Versionskontrollereignisse über Diensthooks benachrichtigt zu werden.

Definitionen

Name	Beschreibung
EventTypeDescriptor	Beschreibt einen Ereignistyp.
InputDataType	Ruft den zu überprüfenden Datentyp ab oder legt diesen fest.
InputDescriptor	Beschreibt eine Eingabe für Abonnements.
InputMode	Modus, in dem 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.
Publisher	Definiert den Datenvertrag eines Ereignisherausgebers.
PublishersQuery	Definiert eine Abfrage für Service Hook-Herausgeber.
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

EventTypeDescriptor

Beschreibt einen Ereignistyp.

Name	Typ	Beschreibung
description	string	Eine lokalisierte Beschreibung des Ereignistyps
id	string	Eine eindeutige ID für den Ereignistyp
inputDescriptors	InputDescriptor[]	Ereignisspezifische Eingaben
name	string	Ein lokalisierter Anzeigename für den Ereignistyp
publisherId	string	Eine eindeutige ID für den Herausgeber dieses Ereignistyps
supportedResourceVersions	string[]	Unterstützte Versionen für die Ressourcennutzlasten des Ereignisses.
url	string	Die URL für diese Ressource

InputDataType

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

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

InputDescriptor

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, wofür diese Eingabe verwendet wird
groupName	string	Der lokalisierte Gruppenname, zu dem 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 der Abhängigkeitseingaben ändert.
id	string	Bezeichner für die Abonnementeingabe
inputMode	InputMode	Modus, in dem 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 können
type	string	Zugrunde liegender Datentyp für den Eingabewert. Wenn dieser Wert angegeben wird, sind InputMode, Validation und Values optional.
useInDefaultDescription	boolean	Ruft ab, ob diese Eingabe in der standardmäßig generierten Aktionsbeschreibung enthalten ist.
validation	InputValidation	Informationen, die zum Überprüfen des Werts dieser Eingabe verwendet werden sollen
valueHint	string	Ein Hinweis für den Eingabewert. Er kann in der Benutzeroberfläche als Eingabeplatzhalter verwendet werden.
values	InputValues	Informationen zu möglichen Werten für diese Eingabe

InputMode

Modus, in dem der Wert dieser Eingabe eingegeben werden soll

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

InputValidation

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	Ruft die maximale Länge dieses Deskriptors ab oder legt diese fest.
maxValue	string	Ruft den Mindestwert für diesen Deskriptor ab oder legt diesen fest.
minLength	integer	Ruft die Mindestlänge dieses Deskriptors ab oder legt diese fest.
minValue	string	Ruft den Mindestwert 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 diese fest.

InputValue

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

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 PossibleValues (True) beschränkt sein, oder sind die Werte in PossibleValues nur ein Vorschlag (False)
isReadOnly	boolean	Sollte diese Eingabe schreibgeschützt sein?
possibleValues	InputValue[]	Mögliche Werte, die diese Eingabe annehmen kann

InputValuesError

Fehlerinformationen im Zusammenhang mit einem Abonnementeingabewert.

Name	Typ	Beschreibung
message	string	Die Fehlermeldung.

Publisher

Definiert den Datenvertrag eines Ereignisherausgebers.

Name	Typ	Beschreibung
_links	ReferenceLinks	Referenzlinks
description	string	Ruft die lokalisierte Beschreibung dieses Herausgebers ab.
id	string	Ruft den Bezeichner dieses Herausgebers ab.
inputDescriptors	InputDescriptor[]	Herausgeberspezifische Eingaben
name	string	Ruft den lokalisierten Namen dieses Herausgebers ab.
serviceInstanceType	string	Der Dienst instance Typ des Erstanbieters.
supportedEvents	EventTypeDescriptor[]	Ruft die unterstützten Ereignistypen dieses Herausgebers ab.
url	string	Die URL für diese Ressource