Consumers - Get

Riferimento

Service:: Service Hooks

API Version:: 7.1-preview.1

Ottenere un servizio consumer specifico. Filtrare facoltativamente le azioni consumer che non supportano alcun tipo di evento per il server di pubblicazione specificato.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
consumerId	path	True	string	ID per un consumer.
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.
publisherId	query		string

Risposte

Nome	Tipo	Descrizione
200 OK	Consumer	operazione riuscita

Sicurezza

oauth2

Type: oauth2
Flow: accessCode
Authorization 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

Scopes

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.

Esempio

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "id": "zendesk",
  "url": "https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk",
  "name": "Zendesk",
  "description": "Zendesk is a SaaS suite that offers help desk ticketing, issue tracking, and customer service support.",
  "imageUrl": "",
  "informationUrl": "http://go.microsoft.com/fwlink/?LinkID=396756",
  "authenticationType": "external",
  "inputDescriptors": [
    {
      "id": "accountName",
      "name": "Account name",
      "description": "Zendesk account name like https://<account name>.zendesk.com",
      "inputMode": "textBox",
      "isConfidential": false,
      "useInDefaultDescription": true,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "pattern": "^([A-Za-z0-9][A-Za-z0-9\\-]{0,61}[A-Za-z0-9]|[A-Za-z0-9]{1,63})$",
        "maxLength": 63
      }
    },
    {
      "id": "username",
      "name": "User name",
      "description": "The Zendesk user name of a user who will update tickets",
      "inputMode": "textBox",
      "isConfidential": false,
      "useInDefaultDescription": false,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "pattern": "^.+\\@.+\\..+$",
        "maxLength": 254
      }
    },
    {
      "id": "apiToken",
      "name": "API token",
      "description": "The Zendesk API token (can be found in Zendesk app in Admin > Channels > API)",
      "inputMode": "passwordBox",
      "isConfidential": true,
      "useInDefaultDescription": false,
      "validation": {
        "dataType": "string",
        "isRequired": true,
        "maxLength": 100
      }
    }
  ],
  "actions": [
    {
      "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": []
    }
  ]
}

Definizioni

Nome	Descrizione
AuthenticationType	Ottiene o imposta il tipo di autenticazione del consumer.
Consumer	Definisce il contratto dati di un consumer.
ConsumerAction	Definisce il contratto dati di un'azione consumer.
ExternalConfigurationDescriptor	Viene descritto come configurare una sottoscrizione gestita esternamente.
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.
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.

AuthenticationType

Ottiene o imposta il tipo di autenticazione del consumer.

Nome	Tipo	Descrizione
external	string	Autenticazione configurata esternamente.
none	string	non è necessaria alcuna autenticazione.
oAuth	string	Autenticazione OAuth.

Consumer

Definisce il contratto dati di un consumer.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti a informazioni di riferimento
actions	ConsumerAction[]	Ottiene le azioni del consumer.
authenticationType	AuthenticationType	Ottiene o imposta il tipo di autenticazione del consumer.
description	string	Ottiene o imposta la descrizione localizzata del consumer.
externalConfiguration	ExternalConfigurationDescriptor	Non Null solo se le sottoscrizioni per questo consumer vengono configurate esternamente.
id	string	Ottiene o imposta l'identificatore del consumer.
imageUrl	string	Ottiene o imposta l'URL dell'immagine del consumer, se presente.
informationUrl	string	Ottiene o imposta l'URL delle informazioni del consumer, se presente.
inputDescriptors	InputDescriptor[]	Ottiene o imposta i descrittori di input del consumer.
name	string	Ottiene o imposta il nome localizzato del consumer.
url	string	URL per questa risorsa

ConsumerAction

Definisce il contratto dati di un'azione consumer.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti a informazioni di riferimento
allowResourceVersionOverride	boolean	Ottiene o imposta il flag che indica se è possibile eseguire l'override della versione della risorsa durante la creazione o la modifica di una sottoscrizione.
consumerId	string	Ottiene o imposta l'identificatore del consumer a cui appartiene questa azione.
description	string	Ottiene o imposta la descrizione localizzata di questa azione.
id	string	Ottiene o imposta l'identificatore dell'azione.
inputDescriptors	InputDescriptor[]	Ottiene o imposta i descrittori di input dell'azione.
name	string	Ottiene o imposta il nome localizzato dell'azione.
supportedEventTypes	string[]	Ottiene o imposta gli identificatori di evento supportati dell'azione.
supportedResourceVersions	object	Ottiene o imposta le versioni di risorse supportate dell'azione.
url	string	URL per questa risorsa

ExternalConfigurationDescriptor

Viene descritto come configurare una sottoscrizione gestita esternamente.

Nome	Tipo	Descrizione
createSubscriptionUrl	string	URL del sito per creare questo tipo di sottoscrizione.
editSubscriptionPropertyName	string	Nome di una proprietà di input che contiene l'URL per modificare una sottoscrizione.
hostedOnly	boolean	True se la configurazione esterna si applica solo a hosted.

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.

ReferenceLinks

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.

Condividi tramite