Condividi tramite


Publishers - Query Publishers

Query per server di pubblicazione hook del servizio.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
path True

string

Nome dell'organizzazione di Azure DevOps.

api-version
query True

string

Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome Tipo Descrizione
publisherIds

string[]

Elenco facoltativo di ID editore per limitare i risultati a

publisherInputs

object

Filtrare gli input dell'editore

results

Publisher[]

Risultati della query

Risposte

Nome Tipo Descrizione
200 OK

PublishersQuery

operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome Descrizione
vso.work Concede la possibilità di leggere elementi di lavoro, query, bacheche, percorsi di aree e iterazioni e altri metadati correlati al rilevamento degli elementi di lavoro. Concede inoltre la possibilità di eseguire query, cercare elementi di lavoro e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.
vso.build Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di compilazione, le definizioni e le richieste e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.
vso.code Concede la possibilità di leggere il codice sorgente e i metadati relativi a commit, insiemi di modifiche, rami e altri artefatti del controllo della versione. Concede inoltre la possibilità di cercare il codice e ricevere notifiche sugli eventi di controllo della versione tramite hook del servizio.

Definizioni

Nome Descrizione
EventTypeDescriptor

Descrive un tipo di evento

InputDataType

Ottiene o imposta il tipo di dati da convalidare.

InputDescriptor

Descrive un input per le sottoscrizioni.

InputMode

Modalità in cui deve essere immesso il valore di questo input

InputValidation

Descrive i valori validi per un input di sottoscrizione

InputValue

Informazioni su un singolo valore per un input

InputValues

Informazioni sui valori possibili/consentiti per un determinato input della sottoscrizione

InputValuesError

Informazioni sugli errori correlate a un valore di input della sottoscrizione.

Publisher

Definisce il contratto dati di un editore di eventi.

PublishersQuery

Definisce una query per server di pubblicazione hook del servizio.

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

EventTypeDescriptor

Descrive un tipo di evento

Nome Tipo Descrizione
description

string

Descrizione localizzata del tipo di evento

id

string

ID univoco per il tipo di evento

inputDescriptors

InputDescriptor[]

Input specifici dell'evento

name

string

Nome descrittivo localizzato per il tipo di evento

publisherId

string

ID univoco per l'autore di questo tipo di evento

supportedResourceVersions

string[]

Versioni supportate per i payload delle risorse dell'evento.

url

string

URL per questa risorsa

InputDataType

Ottiene o imposta il tipo di dati da convalidare.

Nome Tipo Descrizione
boolean

string

Rappresenta un valore true o false.

guid

string

Rappresenta un GUID.

none

string

Non viene specificato alcun tipo di dati.

number

string

Rappresenta un valore numerico.

string

string

Rappresenta un valore testuale.

uri

string

Rappresenta un URI.

InputDescriptor

Descrive un input per le sottoscrizioni.

Nome Tipo Descrizione
dependencyInputIds

string[]

ID di tutti gli input da cui dipende il valore di questo input.

description

string

Descrizione dell'input usato per

groupName

string

Nome localizzato del gruppo a cui appartiene questo input e può essere visualizzato come intestazione per il contenitore che includerà tutti gli input nel gruppo.

hasDynamicValueInformation

boolean

Se true, le informazioni sul valore per questo input sono dinamiche e devono essere recuperate quando il valore degli input di dipendenza cambia.

id

string

Identificatore per l'input della sottoscrizione

inputMode

InputMode

Modalità in cui deve essere immesso il valore di questo input

isConfidential

boolean

Ottiene un valore che indica se l'input è riservato, ad esempio per una password o una chiave dell'applicazione

name

string

Nome localizzato che può essere visualizzato come etichetta per l'input della sottoscrizione

properties

object

Proprietà personalizzate per l'input che può essere usato dal provider di servizi

type

string

Tipo di dati sottostante per il valore di input. Quando si specifica questo valore, InputMode, Validation e Values sono facoltativi.

useInDefaultDescription

boolean

Ottiene un valore che indica se questo input è incluso nella descrizione dell'azione generata predefinita.

validation

InputValidation

Informazioni da usare per convalidare il valore di questo input

valueHint

string

Hint per il valore di input. Può essere usato nell'interfaccia utente come segnaposto di input.

values

InputValues

Informazioni sui valori possibili per questo input

InputMode

Modalità in cui deve essere immesso il valore di questo input

Nome Tipo Descrizione
checkBox

string

La casella di controllo deve essere visualizzata (per valori true/false)

combo

string

Verrà visualizzato un controllo select/combo

none

string

Questo input non deve essere visualizzato nell'interfaccia utente

passwordBox

string

Verrà visualizzata una casella di input della password

radioButtons

string

I pulsanti di opzione devono essere visualizzati

textArea

string

Dovrebbe essere visualizzata un'area di testo a più righe

textBox

string

Verrà visualizzata una casella di testo di input

InputValidation

Descrive i valori validi per un input di sottoscrizione

Nome Tipo Descrizione
dataType

InputDataType

Ottiene o imposta il tipo di dati da convalidare.

isRequired

boolean

Ottiene o imposta se si tratta di un campo obbligatorio.

maxLength

integer

Ottiene o imposta la lunghezza massima del descrittore.

maxValue

string

Ottiene o imposta il valore minimo per questo descrittore.

minLength

integer

Ottiene o imposta la lunghezza minima di questo descrittore.

minValue

string

Ottiene o imposta il valore minimo per questo descrittore.

pattern

string

Ottiene o imposta il modello da convalidare.

patternMismatchErrorMessage

string

Ottiene o imposta l'errore in caso di mancata corrispondenza del criterio.

InputValue

Informazioni su un singolo valore per un input

Nome Tipo Descrizione
data

object

Qualsiasi altro dato su questo input

displayValue

string

Testo da visualizzare per la visualizzazione di questo valore

value

string

Valore da archiviare per questo input

InputValues

Informazioni sui valori possibili/consentiti per un determinato input della sottoscrizione

Nome Tipo Descrizione
defaultValue

string

Valore predefinito da usare per questo input

error

InputValuesError

Errori rilevati durante il calcolo dei valori dinamici.

inputId

string

ID dell'input

isDisabled

boolean

Se l'input deve essere disabilitato

isLimitedToPossibleValues

boolean

Se il valore deve essere limitato a uno dei valori in PossibleValues (True) o i valori in PossibleValues sono solo un suggerimento (False)

isReadOnly

boolean

Se l'input deve essere reso di sola lettura

possibleValues

InputValue[]

Valori possibili che l'input può accettare

InputValuesError

Informazioni sugli errori correlate a un valore di input della sottoscrizione.

Nome Tipo Descrizione
message

string

Messaggio di errore.

Publisher

Definisce il contratto dati di un editore di eventi.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegamenti a informazioni di riferimento

description

string

Ottiene la descrizione localizzata di questo server di pubblicazione.

id

string

Ottiene l'identificatore dell'editore.

inputDescriptors

InputDescriptor[]

Input specifici del server di pubblicazione

name

string

Ottiene il nome localizzato del server di pubblicazione.

serviceInstanceType

string

Tipo di istanza del servizio del server di pubblicazione di prima parte.

supportedEvents

EventTypeDescriptor[]

Ottiene i tipi di evento supportati da questo server di pubblicazione.

url

string

URL per questa risorsa

PublishersQuery

Definisce una query per server di pubblicazione hook del servizio.

Nome Tipo Descrizione
publisherIds

string[]

Elenco facoltativo di ID editore per limitare i risultati a

publisherInputs

object

Filtrare gli input dell'editore

results

Publisher[]

Risultati della query

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.