Publishers - Query Publishers

Referencia

Servicio:: Service Hooks

Versión de la API:: 7.1-preview.1

Consulta de publicadores de enlace de servicio.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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.

Cuerpo de la solicitud

Nombre	Tipo	Description
publisherIds	string[]	Lista opcional de identificadores de publicador para restringir los resultados a
publisherInputs	object	Filtro para entradas de publicador
results	Publisher[]	Resultados de la consulta

Respuestas

Nombre	Tipo	Description
200 OK	PublishersQuery	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

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.

Definiciones

Nombre	Description
EventTypeDescriptor	Describe un tipo de evento
InputDataType	Obtiene o establece el tipo de datos que se va a validar.
InputDescriptor	Describe una entrada para las suscripciones.
InputMode	Modo en el que se debe especificar el valor de esta entrada
InputValidation	Describe qué valores son válidos para una entrada de suscripción.
InputValue	Información sobre un valor único para una entrada
InputValues	Información sobre los valores posibles o permitidos para una entrada de suscripción determinada
InputValuesError	Información de error relacionada con un valor de entrada de suscripción.
Publisher	Define el contrato de datos de un publicador de eventos.
PublishersQuery	Define una consulta para publicadores de enlace de servicio.
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.

EventTypeDescriptor

Describe un tipo de evento

Nombre	Tipo	Description
description	string	Descripción localizada del tipo de evento
id	string	Un identificador único para el tipo de evento
inputDescriptors	InputDescriptor[]	Entradas específicas del evento
name	string	Un nombre descriptivo localizado para el tipo de evento
publisherId	string	Identificador único para el publicador de este tipo de evento
supportedResourceVersions	string[]	Versiones admitidas para las cargas de recursos del evento.
url	string	Dirección URL de este recurso

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	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	InputValidation	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	InputValues	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	InputDataType	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	InputValuesError	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	InputValue[]	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.

Publisher

Define el contrato de datos de un publicador de eventos.

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos de referencia
description	string	Obtiene la descripción localizada de este publicador.
id	string	Obtiene el identificador de este publicador.
inputDescriptors	InputDescriptor[]	Entradas específicas del publicador
name	string	Obtiene el nombre localizado del publicador.
serviceInstanceType	string	Tipo de instancia de servicio del publicador de primera entidad.
supportedEvents	EventTypeDescriptor[]	Obtiene los tipos de eventos admitidos por este publicador.
url	string	Dirección URL de este recurso