Consumers - Get Consumer Action

Riferimento

Service:: Service Hooks

API Version:: 7.1-preview.1

Ottenere informazioni dettagliate su un'azione specifica del consumer.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
consumerActionId	path	True	string	ID per un consumerActionId.
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	ConsumerAction	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, schede, aree e percorsi di iterazione e altri metadati correlati all'elemento di lavoro. Concede inoltre la possibilità di eseguire query, cercare elementi di lavoro e ricevere notifiche sugli eventi dell'elemento 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 codice sorgente e metadati relativi a commit, set di modifiche, rami e altri artefatti di controllo della versione. Concede inoltre la possibilità di cercare codice e ricevere notifiche sugli eventi di controllo della versione tramite gli hook del servizio.

Esempio

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "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
ConsumerAction	Definisce il contratto dati di un'azione consumer.
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 della 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 da rappresentare una raccolta di collegamenti di riferimento REST.

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 dell'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 dall'azione.
supportedResourceVersions	object	Ottiene o imposta le versioni di risorse supportate dell'azione.
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	Nessun tipo di dati specificato.
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 dipendenti dal valore di questo input.
description	string	Descrizione di ciò che viene usato per l'input
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 se questo 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 questo valore è specificato, InputMode, Convalida e Valori sono facoltativi.
useInDefaultDescription	boolean	Ottiene se questo input è incluso nella descrizione dell'azione generata predefinita.
validation	InputValidation	Informazioni da usare per convalidare il valore dell'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	Deve essere visualizzato un controllo select/combo
none	string	Questo input non deve essere visualizzato nell'interfaccia utente
passwordBox	string	Deve essere visualizzata una casella di input password
radioButtons	string	I pulsanti di opzione devono essere visualizzati
textArea	string	Deve essere visualizzata un'area di testo a più righe
textBox	string	Deve essere visualizzata una casella di testo di input

InputValidation

Descrive i valori validi per un input della 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 modello.

InputValue

Informazioni su un singolo valore per un input

Nome	Tipo	Descrizione
data	object	Tutti gli altri dati relativi all'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 riscontrati durante il calcolo dei valori dinamici.
inputId	string	ID dell'input
isDisabled	boolean	Deve essere disabilitato questo input
isLimitedToPossibleValues	boolean	Se il valore deve essere limitato a uno dei valori in PossibleValues (True) o sono i valori in PossibleValues solo un suggerimento (False)
isReadOnly	boolean	Se questo input deve essere reso di sola lettura
possibleValues	InputValue[]	Valori possibili che questo 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 da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

Condividi tramite