Publishers - Get
Získejte konkrétního vydavatele zavěšení služby.
GET https://dev.azure.com/{organization}/_apis/hooks/publishers/{publisherId}?api-version=7.1-preview.1Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Název organizace Azure DevOps. |
|
publisher
|
path | True |
string |
ID vydavatele. |
|
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
ú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. Poskytuje také možnost spouštět dotazy, hledat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím zachytávejte 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žeb. |
| 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 hooků služeb. |
Definice
| Name | Description |
|---|---|
|
Event |
Popisuje typ události. |
|
Input |
Získá nebo nastaví datový typ k ověření. |
|
Input |
Popisuje vstup pro předplatná. |
|
Input |
Režim, ve kterém má být zadána hodnota tohoto vstupu |
|
Input |
Popisuje platné hodnoty pro vstup předplatného. |
|
Input |
Informace o jedné hodnotě pro vstup |
|
Input |
Informace o možných/povolených hodnotách pro daný vstup předplatného |
|
Input |
Informace o chybě související se vstupní hodnotou předplatného |
| Publisher |
Definuje kontrakt dat vydavatele události. |
|
Reference |
Třída představující kolekci odkazů REST. |
EventTypeDescriptor
Popisuje typ události.
| Name | Typ | Description |
|---|---|---|
| description |
string |
Lokalizovaný popis typu události |
| id |
string |
Jedinečné ID pro typ události |
| inputDescriptors |
Vstupy specifické pro události |
|
| name |
string |
Lokalizovaný popisný název pro typ události |
| publisherId |
string |
Jedinečné ID pro 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
Získá nebo nastaví datový typ k ověření.
| Name | Typ | Description |
|---|---|---|
| boolean |
string |
Představuje hodnotu true nebo false. |
| guid |
string |
Představuje identifikátor GUID. |
| none |
string |
Není zadán žádný datový typ. |
| number |
string |
Představuje číselnou hodnotu. |
| string |
string |
Představuje textovou hodnotu. |
| uri |
string |
Představuje identifikátor URI. |
InputDescriptor
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, k čemu se tento vstup používá |
| groupName |
string |
Lokalizovaný název skupiny, ke které tento vstup patří a který lze zobrazit jako hlavičku 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 se načíst, když se změní hodnota vstupů závislostí. |
| id |
string |
Identifikátor vstupu předplatného |
| inputMode |
Režim, ve kterém má být zadána hodnota tohoto vstupu |
|
| isConfidential |
boolean |
Získá, jestli je tento vstup důvěrný, například pro heslo nebo klíč aplikace. |
| name |
string |
Lokalizovaný název, který se může zobrazit jako popisek pro vstup předplatného |
| properties |
object |
Vlastní vlastnosti pro vstup, které může použít poskytovatel služeb |
| type |
string |
Podkladový datový typ vstupní hodnoty. Při zadání této hodnoty jsou InputMode, Validation a Values volitelné. |
| useInDefaultDescription |
boolean |
Získá, zda je tento vstup součástí výchozího vygenerovaného popisu akce. |
| validation |
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 zástupný symbol vstupu. |
| values |
Informace o možných hodnotách pro tento vstup |
InputMode
Režim, ve kterém má být zadána hodnota tohoto vstupu
| Name | Typ | Description |
|---|---|---|
| checkBox |
string |
Mělo by se zobrazit zaškrtávací políčko (pro hodnoty true/false) |
| combo |
string |
Měl by se zobrazit ovládací prvek se seznamem nebo výběrem. |
| none |
string |
Tento vstup by se neměl zobrazovat v uživatelském rozhraní. |
| passwordBox |
string |
Mělo by se zobrazit pole pro zadání hesla. |
| radioButtons |
string |
Měly by se zobrazit přepínače |
| textArea |
string |
Měla by se zobrazit víceřádková textová oblast. |
| textBox |
string |
Mělo by se zobrazit vstupní textové pole. |
InputValidation
Popisuje platné hodnoty pro vstup předplatného.
| Name | Typ | Description |
|---|---|---|
| dataType |
Získá nebo nastaví datový typ k ověření. |
|
| isRequired |
boolean |
Získá nebo nastaví, pokud se jedná o povinné pole. |
| maxLength |
integer |
Získá nebo nastaví maximální délku tohoto popisovače. |
| maxValue |
string |
Získá nebo nastaví minimální hodnotu pro tento popisovač. |
| minLength |
integer |
Získá nebo nastaví minimální délku tohoto popisovače. |
| minValue |
string |
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
Informace o jedné hodnotě pro vstup
| Name | Typ | Description |
|---|---|---|
| data |
object |
Veškerá 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
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 |
Při výpočtu dynamických hodnot došlo k chybám. |
|
| inputId |
string |
ID vstupu |
| isDisabled |
boolean |
Měl by být tento vstup zakázán. |
| isLimitedToPossibleValues |
boolean |
Měla by být hodnota omezená na jednu z hodnot v části PossibleValues (True) nebo jsou hodnoty v PossibleValues jen návrhem (Nepravda). |
| isReadOnly |
boolean |
Má být tento vstup určen jen pro čtení |
| possibleValues |
Možné hodnoty, které tento vstup může mít |
InputValuesError
Informace o chybě související se vstupní hodnotou předplatného
| Name | Typ | Description |
|---|---|---|
| message |
string |
Chybová zpráva |
Publisher
Definuje kontrakt dat vydavatele události.
| Name | Typ | Description |
|---|---|---|
| _links |
Odkazy |
|
| description |
string |
Získá lokalizovaný popis tohoto vydavatele. |
| id |
string |
Získá identifikátor tohoto vydavatele. |
| inputDescriptors |
Vstupy specifické pro vydavatele |
|
| name |
string |
Získá lokalizovaný název tohoto vydavatele. |
| serviceInstanceType |
string |
Typ instance služby vydavatele první strany. |
| supportedEvents |
Získá podporované typy událostí tohoto vydavatele. |
|
| url |
string |
Adresa URL pro tento prostředek |
ReferenceLinks
Třída představující kolekci odkazů REST.
| Name | Typ | Description |
|---|---|---|
| links |
object |
Zobrazení odkazů jen pro čtení. Odkazy jsou jen pro čtení, a proto je chceme zveřejnit jen jako odkazy jen pro čtení. |