Consumers - Get
Obtener un servicio de consumidor específico. Opcionalmente, filtre las acciones de consumidor que no admitan ningún tipo de evento para el publicador especificado.
GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?publisherId={publisherId}&api-version=7.1-preview.1
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
consumer
|
path | True |
string |
Identificador de un consumidor. |
organization
|
path | True |
string |
El nombre de la organización de Azure DevOps. |
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API. |
publisher
|
query |
string |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
operación correcta |
Seguridad
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
Nombre | Description |
---|---|
vso.work | Concede la capacidad de leer elementos de trabajo, consultas, paneles, rutas de acceso de área e iteraciones y otros metadatos relacionados con el seguimiento de elementos de trabajo. También concede la capacidad de ejecutar consultas, buscar elementos de trabajo y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio. |
vso.build | Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio. |
vso.code | Concede la capacidad de leer el código fuente y los metadatos sobre confirmaciones, conjuntos de cambios, ramas y otros artefactos de control de versiones. También concede la capacidad de buscar código y recibir notificaciones sobre los eventos de control de versiones a través de enlaces de servicio. |
Ejemplos
Sample Request
GET https://dev.azure.com/fabrikam/_apis/hooks/consumers/zendesk?api-version=7.1-preview.1
Sample Response
{
"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": []
}
]
}
Definiciones
Nombre | Description |
---|---|
Authentication |
Obtiene o establece el tipo de autenticación de este consumidor. |
Consumer |
Define el contrato de datos de un consumidor. |
Consumer |
Define el contrato de datos de una acción de consumidor. |
External |
Describe cómo configurar una suscripción administrada externamente. |
Input |
Obtiene o establece el tipo de datos que se va a validar. |
Input |
Describe una entrada para las suscripciones. |
Input |
Modo en el que se debe especificar el valor de esta entrada |
Input |
Describe qué valores son válidos para una entrada de suscripción. |
Input |
Información sobre un valor único para una entrada |
Input |
Información sobre los valores posibles o permitidos para una entrada de suscripción determinada |
Input |
Información de error relacionada con un valor de entrada de suscripción. |
Reference |
Clase que representa una colección de vínculos de referencia de REST. |
AuthenticationType
Obtiene o establece el tipo de autenticación de este consumidor.
Nombre | Tipo | Description |
---|---|---|
external |
string |
Autenticación configurada externamente. |
none |
string |
No se requiere autenticación. |
oAuth |
string |
Autenticación de OAuth. |
Consumer
Define el contrato de datos de un consumidor.
Nombre | Tipo | Description |
---|---|---|
_links |
Vínculos de referencia |
|
actions |
Obtiene las acciones de este consumidor. |
|
authenticationType |
Obtiene o establece el tipo de autenticación de este consumidor. |
|
description |
string |
Obtiene o establece la descripción localizada de este consumidor. |
externalConfiguration |
Solo es null si las suscripciones de este consumidor están configuradas externamente. |
|
id |
string |
Obtiene o establece el identificador de este consumidor. |
imageUrl |
string |
Obtiene o establece la dirección URL de la imagen de este consumidor, si existe. |
informationUrl |
string |
Obtiene o establece la dirección URL de información de este consumidor, si existe. |
inputDescriptors |
Obtiene o establece los descriptores de entrada de este consumidor. |
|
name |
string |
Obtiene o establece el nombre localizado de este consumidor. |
url |
string |
Dirección URL de este recurso |
ConsumerAction
Define el contrato de datos de una acción de consumidor.
Nombre | Tipo | Description |
---|---|---|
_links |
Vínculos de referencia |
|
allowResourceVersionOverride |
boolean |
Obtiene o establece la marca que indica si se puede invalidar la versión del recurso al crear o editar una suscripción. |
consumerId |
string |
Obtiene o establece el identificador del consumidor al que pertenece esta acción. |
description |
string |
Obtiene o establece la descripción localizada de esta acción. |
id |
string |
Obtiene o establece el identificador de esta acción. |
inputDescriptors |
Obtiene o establece los descriptores de entrada de esta acción. |
|
name |
string |
Obtiene o establece el nombre localizado de esta acción. |
supportedEventTypes |
string[] |
Obtiene o establece los identificadores de eventos admitidos de esta acción. |
supportedResourceVersions |
object |
Obtiene o establece las versiones de recursos admitidas de esta acción. |
url |
string |
Dirección URL de este recurso |
ExternalConfigurationDescriptor
Describe cómo configurar una suscripción administrada externamente.
Nombre | Tipo | Description |
---|---|---|
createSubscriptionUrl |
string |
Dirección URL del sitio para crear este tipo de suscripción. |
editSubscriptionPropertyName |
string |
Nombre de una propiedad de entrada que contiene la dirección URL para editar una suscripción. |
hostedOnly |
boolean |
True si la configuración externa solo se aplica a hospedado. |
InputDataType
Obtiene o establece el tipo de datos que se va a validar.
Nombre | Tipo | Description |
---|---|---|
boolean |
string |
Representa un valor de true o false. |
guid |
string |
Representa un GUID. |
none |
string |
No se especifica ningún tipo de datos. |
number |
string |
Representa un valor numérico. |
string |
string |
Representa un valor de texto. |
uri |
string |
Representa un URI. |
InputDescriptor
Describe una entrada para las suscripciones.
Nombre | Tipo | Description |
---|---|---|
dependencyInputIds |
string[] |
Identificadores de todas las entradas en las que depende el valor de esta entrada. |
description |
string |
Descripción de lo que se usa esta entrada para |
groupName |
string |
El nombre localizado del grupo al que pertenece esta entrada y se puede mostrar como un encabezado para el contenedor que incluirá todas las entradas del grupo. |
hasDynamicValueInformation |
boolean |
Si es true, la información de valor de esta entrada es dinámica y debe capturarse cuando cambie el valor de las entradas de dependencia. |
id |
string |
Identificador de la entrada de suscripción |
inputMode |
Modo en el que se debe especificar el valor de esta entrada |
|
isConfidential |
boolean |
Obtiene si esta entrada es confidencial, como para una contraseña o una clave de aplicación. |
name |
string |
Nombre localizado que se puede mostrar como una etiqueta para la entrada de la suscripción |
properties |
object |
Propiedades personalizadas para la entrada que el proveedor de servicios puede usar |
type |
string |
Tipo de datos subyacente para el valor de entrada. Cuando se especifica este valor, InputMode, Validation y Values son opcionales. |
useInDefaultDescription |
boolean |
Obtiene si esta entrada se incluye en la descripción de la acción generada predeterminada. |
validation |
Información que se va a usar para validar el valor de esta entrada |
|
valueHint |
string |
Sugerencia para el valor de entrada. Se puede usar en la interfaz de usuario como marcador de posición de entrada. |
values |
Información sobre los valores posibles para esta entrada |
InputMode
Modo en el que se debe especificar el valor de esta entrada
Nombre | Tipo | Description |
---|---|---|
checkBox |
string |
Se debe mostrar la casilla (para valores true/false) |
combo |
string |
Se debe mostrar un control select/combo |
none |
string |
Esta entrada no se debe mostrar en la interfaz de usuario. |
passwordBox |
string |
Se debe mostrar un cuadro de entrada de contraseña |
radioButtons |
string |
Se deben mostrar los botones de radio |
textArea |
string |
Se debe mostrar un área de texto de varias líneas |
textBox |
string |
Se debe mostrar un cuadro de texto de entrada |
InputValidation
Describe qué valores son válidos para una entrada de suscripción.
Nombre | Tipo | Description |
---|---|---|
dataType |
Obtiene o establece el tipo de datos que se va a validar. |
|
isRequired |
boolean |
Obtiene o establece si se trata de un campo obligatorio. |
maxLength |
integer |
Obtiene o establece la longitud máxima de este descriptor. |
maxValue |
string |
Obtiene o establece el valor mínimo de este descriptor. |
minLength |
integer |
Obtiene o establece la longitud mínima de este descriptor. |
minValue |
string |
Obtiene o establece el valor mínimo de este descriptor. |
pattern |
string |
Obtiene o establece el patrón que se va a validar. |
patternMismatchErrorMessage |
string |
Obtiene o establece el error al no coincidir el patrón. |
InputValue
Información sobre un valor único para una entrada
Nombre | Tipo | Description |
---|---|---|
data |
object |
Cualquier otro dato sobre esta entrada |
displayValue |
string |
Texto que se va a mostrar para la presentación de este valor |
value |
string |
Valor que se va a almacenar para esta entrada. |
InputValues
Información sobre los valores posibles o permitidos para una entrada de suscripción determinada
Nombre | Tipo | Description |
---|---|---|
defaultValue |
string |
Valor predeterminado que se va a usar para esta entrada |
error |
Errores detectados al calcular valores dinámicos. |
|
inputId |
string |
Identificador de la entrada |
isDisabled |
boolean |
Si esta entrada está deshabilitada |
isLimitedToPossibleValues |
boolean |
Si el valor se restringe a uno de los valores de PossibleValues (True) o son los valores de PossibleValues solo una sugerencia (False) |
isReadOnly |
boolean |
Si esta entrada se hace de solo lectura |
possibleValues |
Valores posibles que esta entrada puede tomar |
InputValuesError
Información de error relacionada con un valor de entrada de suscripción.
Nombre | Tipo | Description |
---|---|---|
message |
string |
El mensaje de error. |
ReferenceLinks
Clase que representa una colección de vínculos de referencia de REST.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |