Consumers - Get Consumer Action
Obtenez des détails sur une action spécifique du consommateur.
GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}/actions/{consumerActionId}?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}/actions/{consumerActionId}?publisherId={publisherId}&api-version=7.1-preview.1
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
consumer
|
path | True |
string |
ID d’un consumerActionId. |
consumer
|
path | True |
string |
ID pour 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. |
publisher
|
query |
string |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
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 d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité 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 concernant 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 informé des événements de contrôle de version via des hooks de service. |
Exemples
Sample Request
GET https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk/actions/createPrivateComment?api-version=7.1-preview.1
Sample Response
{
"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 |
---|---|
Consumer |
Définit le contrat de données d’une action de consommateur. |
Input |
Obtient ou définit le type de données à valider. |
Input |
Décrit une entrée pour les abonnements. |
Input |
Mode dans lequel la valeur de cette entrée doit être entrée |
Input |
Décrit les valeurs valides pour une entrée d’abonnement |
Input |
Informations sur une valeur unique pour une entrée |
Input |
Informations sur les valeurs possibles/autorisées pour une entrée d’abonnement donnée |
Input |
Informations d’erreur relatives à une valeur d’entrée d’abonnement. |
Reference |
Classe pour représenter une collection de liens de référence REST. |
ConsumerAction
Définit le contrat de données d’une action de consommateur.
Nom | Type | Description |
---|---|---|
_links |
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 |
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 de cette action. |
supportedResourceVersions |
object |
Obtient ou définit les versions de ressources prises en charge de cette action. |
url |
string |
URL de cette ressource |
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 cette entrée appartient et peut être affiché en tant qu’en-tête pour le conteneur qui inclura toutes les entrées dans le groupe. |
hasDynamicValueInformation |
boolean |
Si la valeur est true, les informations de valeur de 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 |
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é sous forme d’é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 |
Informations à utiliser pour valider la valeur de cette entrée |
|
valueHint |
string |
Indicateur de valeur d’entrée. Il peut être utilisé dans l’interface utilisateur comme espace réservé d’entrée. |
values |
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 être affichée |
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 |
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 de ce descripteur. |
minLength |
integer |
Obtient ou définit la longueur minimale de ce descripteur. |
minValue |
string |
Obtient ou définit la valeur minimale de ce descripteur. |
pattern |
string |
Obtient ou définit le modèle à valider. |
patternMismatchErrorMessage |
string |
Obtient ou définit l’erreur sur l’incompatibilité de modèle. |
InputValue
Informations sur une valeur unique pour une entrée
Nom | Type | Description |
---|---|---|
data |
object |
Toutes les autres données relatives à 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 |
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 PossiblesValues (True) ou les valeurs de PossibleValues sont-elles simplement une suggestion (False) |
isReadOnly |
boolean |
Si cette entrée est en lecture seule |
possibleValues |
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 de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |