Publishers - Query Publishers

Reference

Služba:: Service Hooks

Verze rozhraní API:: 7.1

Dotaz na vydavatele háku služby

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
api-version	query	True	string	Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Text požadavku

Name	Typ	Description
publisherIds	string[]	Volitelný seznam ID vydavatele pro omezení výsledků na
publisherInputs	object	Filtrování vstupů vydavatele
results	Publisher[]	Výsledky z dotazu

Odpovědi

Name	Typ	Description
200 OK	PublishersQuery	úspěšná operace

Zabezpečení

oauth2

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

Rozsahy

Name	Description
vso.work	Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Umožňuje také spouštět dotazy, prohledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím volání služby.
vso.build	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služby.
vso.code	Uděluje možnost číst zdrojový kód a metadata o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také prohledávat kód a dostávat oznámení o událostech správy verzí prostřednictvím háků služby.

Definice

Name	Description
EventTypeDescriptor	Popisuje typ události.
InputDataType	Získá nebo nastaví datový typ k ověření.
InputDescriptor	Popisuje vstup pro předplatná.
InputMode	Režim, ve kterém má být zadána hodnota tohoto vstupu
InputValidation	Popisuje, jaké hodnoty jsou platné pro vstup předplatného.
InputValue	Informace o jedné hodnotě pro vstup
InputValues	Informace o možných/povolených hodnotách pro daný vstup předplatného
InputValuesError	Informace o chybě související se vstupní hodnotou předplatného
Publisher	Definuje kontrakt dat vydavatele události.
PublishersQuery	Definuje dotaz pro vydavatele háku služby.
ReferenceLinks	Třída představující kolekci odkazů REST.

EventTypeDescriptor

Objekt

Popisuje typ události.

Name	Typ	Description
description	string	Lokalizovaný popis typu události
id	string	Jedinečné ID pro typ události
inputDescriptors	InputDescriptor[]	Vstupy specifické pro události
name	string	Lokalizovaný popisný název pro typ události
publisherId	string	Jedinečné ID vydavatele tohoto typu události
supportedResourceVersions	string[]	Podporované verze datových částí prostředků události
url	string	Adresa URL pro tento prostředek

InputDataType

Výčet

Získá nebo nastaví datový typ k ověření.

Hodnota	Description
boolean	Představuje hodnotu true nebo false.
guid	Představuje identifikátor GUID.
none	Není zadán žádný datový typ.
number	Představuje číselnou hodnotu.
string	Představuje textovou hodnotu.
uri	Představuje identifikátor URI.

InputDescriptor

Objekt

Popisuje vstup pro předplatná.

Name	Typ	Description
dependencyInputIds	string[]	ID všech vstupů, na které je hodnota tohoto vstupu závislá.
description	string	Popis toho, k čemu se tento vstup používá
groupName	string	Lokalizovaný název skupiny, do které tento vstup patří, a může se zobrazit jako záhlaví kontejneru, který bude obsahovat všechny vstupy ve skupině.
hasDynamicValueInformation	boolean	Pokud je hodnota true, informace o hodnotě pro tento vstup jsou dynamické a měly by být načteny při změně hodnoty vstupů závislostí.
id	string	Identifikátor vstupu předplatného
inputMode	InputMode	Režim, ve kterém má být zadána hodnota tohoto vstupu
isConfidential	boolean	Získá, zda je tento vstup důvěrný, například pro heslo nebo klíč aplikace.
name	string	Lokalizovaný název, který se dá zobrazit jako popisek vstupu předplatného
properties	object	Vlastní vlastnosti pro vstup, který může použít poskytovatel služeb
type	string	Podkladový datový typ pro vstupní hodnotu. Pokud je tato hodnota zadána, InputMode, Validation a Values jsou volitelné.
useInDefaultDescription	boolean	Získá, zda je tento vstup zahrnut do výchozího vygenerovaného popisu akce.
validation	InputValidation	Informace, které se mají použít k ověření hodnoty tohoto vstupu
valueHint	string	Nápověda pro vstupní hodnotu. Dá se použít v uživatelském rozhraní jako vstupní zástupný symbol.
values	InputValues	Informace o možných hodnotách pro tento vstup

InputMode

Výčet

Režim, ve kterém má být zadána hodnota tohoto vstupu

Hodnota	Description
checkBox	Zaškrtávací políčko by se mělo zobrazit (pro hodnoty true/false)
combo	Měl by se zobrazit ovládací prvek select/combo.
none	Tento vstup by neměl být zobrazen v uživatelském rozhraní.
passwordBox	Mělo by se zobrazit pole pro zadání hesla.
radioButtons	Přepínače by měly být zobrazeny.
textArea	Měla by se zobrazit víceřádkové textové oblasti.
textBox	Mělo by se zobrazit vstupní textové pole.

InputValidation

Objekt

Popisuje, jaké hodnoty jsou platné pro vstup předplatného.

Name	Typ	Description
dataType	InputDataType	Získá nebo nastaví datový typ k ověření.
isRequired	boolean	Získá nebo nastaví, pokud se jedná o povinné pole.
maxLength	integer (int32)	Získá nebo nastaví maximální délku tohoto popisovače.
maxValue	string (decimal)	Získá nebo nastaví minimální hodnotu pro tento popisovač.
minLength	integer (int32)	Získá nebo nastaví minimální délku tohoto popisovače.
minValue	string (decimal)	Získá nebo nastaví minimální hodnotu pro tento popisovač.
pattern	string	Získá nebo nastaví vzor k ověření.
patternMismatchErrorMessage	string	Získá nebo nastaví chybu při neshodě vzorů.

InputValue

Objekt

Informace o jedné hodnotě pro vstup

Name	Typ	Description
data	object	Všechna další data o tomto vstupu
displayValue	string	Text, který se má zobrazit pro zobrazení této hodnoty
value	string	Hodnota, která se má uložit pro tento vstup

InputValues

Objekt

Informace o možných/povolených hodnotách pro daný vstup předplatného

Name	Typ	Description
defaultValue	string	Výchozí hodnota, která se má použít pro tento vstup
error	InputValuesError	Při výpočtu dynamických hodnot došlo k chybám.
inputId	string	ID vstupu
isDisabled	boolean	Má být tento vstup zakázaný.
isLimitedToPossibleValues	boolean	Pokud je hodnota omezena na jednu z hodnot v možných hodnotách (True) nebo jsou hodnoty v PossibleValues pouze návrh (False).
isReadOnly	boolean	Je-li tento vstup určen jen pro čtení
possibleValues	InputValue[]	Možné hodnoty, které tento vstup může převzít

InputValuesError

Objekt

Informace o chybě související se vstupní hodnotou předplatného

Name	Typ	Description
message	string	Chybová zpráva.

Publisher

Objekt

Definuje kontrakt dat vydavatele události.

Name	Typ	Description
_links	ReferenceLinks	Odkazy
description	string	Získá lokalizovaný popis tohoto vydavatele.
id	string	Získá identifikátor tohoto vydavatele.
inputDescriptors	InputDescriptor[]	Vstupy specifické pro vydavatele
name	string	Získá lokalizovaný název tohoto vydavatele.
serviceInstanceType	string	Typ instance služby vydavatele první strany.
supportedEvents	EventTypeDescriptor[]	Získá podporované typy událostí tohoto vydavatele.
url	string	Adresa URL pro tento prostředek