Consumers - Get

Référence

Service:: Service Hooks

API Version:: 7.1-preview.1

Obtenir un service consommateur spécifique. Si vous le souhaitez, filtrez les actions du consommateur qui ne prennent en charge aucun type d’événement pour le serveur de publication spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
consumerId	path	True	string	ID d’un consommateur.
organization	path	True	string	Nom de l’organisation Azure DevOps.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.
publisherId	query		string

Réponses

Nom	Type	Description
200 OK	Consumer	opération réussie

Sécurité

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

Nom	Description
vso.work	Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins de zone et d’itérations et d’autres métadonnées associées au suivi des éléments de travail. Permet également d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.
vso.build	Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, et la possibilité de recevoir des notifications sur les événements de build via des hooks de service.
vso.code	Accorde la possibilité de lire le code source et les métadonnées sur les commits, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être averti des événements de contrôle de version via des hooks de service.

Exemples

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": []
    }
  ]
}

Définitions

Nom	Description
AuthenticationType	Obtient ou définit le type d’authentification de ce consommateur.
Consumer	Définit le contrat de données d’un consommateur.
ConsumerAction	Définit le contrat de données d’une action de consommateur.
ExternalConfigurationDescriptor	Décrit comment configurer un abonnement géré en externe.
InputDataType	Obtient ou définit le type de données à valider.
InputDescriptor	Décrit une entrée pour les abonnements.
InputMode	Mode dans lequel la valeur de cette entrée doit être entrée
InputValidation	Décrit les valeurs valides pour une entrée d’abonnement
InputValue	Informations sur une valeur unique pour une entrée
InputValues	Informations sur les valeurs possibles/autorisées pour une entrée d’abonnement donnée
InputValuesError	Informations d’erreur relatives à une valeur d’entrée d’abonnement.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.

AuthenticationType

Obtient ou définit le type d’authentification de ce consommateur.

Nom	Type	Description
external	string	Authentification configurée en externe.
none	string	aucune authentification n’est requise.
oAuth	string	Authentification OAuth.

Consumer

Définit le contrat de données d’un consommateur.

Nom	Type	Description
_links	ReferenceLinks	Liens de référence
actions	ConsumerAction[]	Obtient les actions de ce consommateur.
authenticationType	AuthenticationType	Obtient ou définit le type d’authentification de ce consommateur.
description	string	Obtient ou définit la description localisée de ce consommateur.
externalConfiguration	ExternalConfigurationDescriptor	Non null uniquement si les abonnements de ce consommateur sont configurés en externe.
id	string	Obtient ou définit l’identificateur de ce consommateur.
imageUrl	string	Obtient ou définit l’URL de l’image de ce consommateur, le cas échéant.
informationUrl	string	Obtient ou définit l’URL des informations de ce consommateur, le cas échéant.
inputDescriptors	InputDescriptor[]	Obtient ou définit les descripteurs d’entrée de ce consommateur.
name	string	Obtient ou définit le nom localisé de ce consommateur.
url	string	URL de cette ressource

ConsumerAction

Définit le contrat de données d’une action de consommateur.

Nom	Type	Description
_links	ReferenceLinks	Liens de référence
allowResourceVersionOverride	boolean	Obtient ou définit l’indicateur indiquant si la version de ressource peut être remplacée lors de la création ou de la modification d’un abonnement.
consumerId	string	Obtient ou définit l’identificateur du consommateur auquel cette action appartient.
description	string	Obtient ou définit la description localisée de cette action.
id	string	Obtient ou définit l’identificateur de cette action.
inputDescriptors	InputDescriptor[]	Obtient ou définit les descripteurs d’entrée de cette action.
name	string	Obtient ou définit le nom localisé de cette action.
supportedEventTypes	string[]	Obtient ou définit les identificateurs d’événement pris en charge par cette action.
supportedResourceVersions	object	Obtient ou définit les versions de ressources prises en charge par cette action.
url	string	URL de cette ressource

ExternalConfigurationDescriptor

Décrit comment configurer un abonnement géré en externe.

Nom	Type	Description
createSubscriptionUrl	string	URL du site pour créer ce type d’abonnement.
editSubscriptionPropertyName	string	Nom d’une propriété d’entrée qui contient l’URL permettant de modifier un abonnement.
hostedOnly	boolean	True si la configuration externe s’applique uniquement à hosted.

InputDataType

Obtient ou définit le type de données à valider.

Nom	Type	Description
boolean	string	Représente une valeur true ou false.
guid	string	Représente un GUID.
none	string	Aucun type de données n’est spécifié.
number	string	Représente une valeur numérique.
string	string	Représente une valeur textuelle.
uri	string	Représente un URI.

InputDescriptor

Décrit une entrée pour les abonnements.

Nom	Type	Description
dependencyInputIds	string[]	ID de toutes les entrées dont dépend la valeur de cette entrée.
description	string	Description de l’utilisation de cette entrée
groupName	string	Nom localisé du groupe auquel appartient cette entrée et peut être affiché en tant qu’en-tête pour le conteneur qui inclut toutes les entrées du groupe.
hasDynamicValueInformation	boolean	Si la valeur est true, les informations de valeur pour cette entrée sont dynamiques et doivent être extraites lorsque la valeur des entrées de dépendance change.
id	string	Identificateur de l’entrée d’abonnement
inputMode	InputMode	Mode dans lequel la valeur de cette entrée doit être entrée
isConfidential	boolean	Obtient si cette entrée est confidentielle, par exemple pour un mot de passe ou une clé d’application
name	string	Nom localisé qui peut être affiché en tant qu’étiquette pour l’entrée d’abonnement
properties	object	Propriétés personnalisées pour l’entrée qui peut être utilisée par le fournisseur de services
type	string	Type de données sous-jacent pour la valeur d’entrée. Lorsque cette valeur est spécifiée, InputMode, Validation et Values sont facultatifs.
useInDefaultDescription	boolean	Obtient si cette entrée est incluse dans la description de l’action générée par défaut.
validation	InputValidation	Informations à utiliser pour valider la valeur de cette entrée
valueHint	string	Indicateur pour la valeur d’entrée. Il peut être utilisé dans l’interface utilisateur comme espace réservé d’entrée.
values	InputValues	Informations sur les valeurs possibles pour cette entrée

InputMode

Mode dans lequel la valeur de cette entrée doit être entrée

Nom	Type	Description
checkBox	string	La case à cocher doit être affichée (pour les valeurs true/false)
combo	string	Un contrôle select/combo doit être affiché
none	string	Cette entrée ne doit pas être affichée dans l’interface utilisateur
passwordBox	string	Une zone d’entrée de mot de passe doit s’afficher
radioButtons	string	Les cases d’option doivent être affichées
textArea	string	Une zone de texte multiligne doit être affichée
textBox	string	Une zone de texte d’entrée doit être affichée

InputValidation

Décrit les valeurs valides pour une entrée d’abonnement

Nom	Type	Description
dataType	InputDataType	Obtient ou définit le type de données à valider.
isRequired	boolean	Obtient ou définit s’il s’agit d’un champ obligatoire.
maxLength	integer	Obtient ou définit la longueur maximale de ce descripteur.
maxValue	string	Obtient ou définit la valeur minimale pour ce descripteur.
minLength	integer	Obtient ou définit la longueur minimale de ce descripteur.
minValue	string	Obtient ou définit la valeur minimale pour ce descripteur.
pattern	string	Obtient ou définit le modèle à valider.
patternMismatchErrorMessage	string	Obtient ou définit l’erreur en cas d’incompatibilité de modèle.

InputValue

Informations sur une valeur unique pour une entrée

Nom	Type	Description
data	object	Toute autre donnée concernant cette entrée
displayValue	string	Texte à afficher pour l’affichage de cette valeur
value	string	Valeur à stocker pour cette entrée

InputValues

Informations sur les valeurs possibles/autorisées pour une entrée d’abonnement donnée

Nom	Type	Description
defaultValue	string	Valeur par défaut à utiliser pour cette entrée
error	InputValuesError	Erreurs rencontrées lors du calcul des valeurs dynamiques.
inputId	string	ID de l’entrée
isDisabled	boolean	Si cette entrée est désactivée
isLimitedToPossibleValues	boolean	La valeur doit-elle être limitée à l’une des valeurs dans les Valeurs Possibles (True) ou les valeurs de PossibleValues sont-elles simplement une suggestion (False)
isReadOnly	boolean	Cette entrée doit-elle être rendue en lecture seule
possibleValues	InputValue[]	Valeurs possibles que cette entrée peut prendre

InputValuesError

Informations d’erreur relatives à une valeur d’entrée d’abonnement.

Nom	Type	Description
message	string	Message d’erreur.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

Partager via