Consumers - Get

Referência

Serviço:: Service Hooks

Versão da API:: 7.1

Obtenha um serviço de consumidor específico. Opcionalmente, filtre as ações do consumidor que não dão suporte a nenhum tipo de evento para o publicador especificado.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
consumerId	path	True	string	ID de um consumidor.
organization	path	True	string	O nome da organização do Azure DevOps.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.
publisherId	query		string

Respostas

Nome	Tipo	Description
200 OK	Consumer	operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do 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

Escopos

Nome	Description
vso.work	Concede a capacidade de ler itens de trabalho, consultas, placas, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.
vso.build	Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.
vso.code	Concede a capacidade de ler o código-fonte e metadados sobre commits, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de pesquisar código e ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Exemplos

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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": []
    }
  ]
}

Definições

Nome	Description
AuthenticationType	Obtém ou define o tipo de autenticação desse consumidor.
Consumer	Define o contrato de dados de um consumidor.
ConsumerAction	Define o contrato de dados de uma ação do consumidor.
ExternalConfigurationDescriptor	Descreve como configurar uma assinatura gerenciada externamente.
InputDataType	Obtém ou define o tipo de dados a ser validado.
InputDescriptor	Descreve uma entrada para assinaturas.
InputMode	Modo no qual o valor dessa entrada deve ser inserido
InputValidation	Descreve quais valores são válidos para uma entrada de assinatura
InputValue	Informações sobre um único valor para uma entrada
InputValues	Informações sobre os valores possíveis/permitidos para uma determinada entrada de assinatura
InputValuesError	Informações de erro relacionadas a um valor de entrada de assinatura.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.

AuthenticationType

Enumeração

Obtém ou define o tipo de autenticação desse consumidor.

Valor	Description
external	Autenticação configurada externamente.
none	Nenhuma autenticação é necessária.
oAuth	Autenticação OAuth.

Consumer

Objeto

Define o contrato de dados de um consumidor.

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência
actions	ConsumerAction[]	Obtém as ações desse consumidor.
authenticationType	AuthenticationType	Obtém ou define o tipo de autenticação desse consumidor.
description	string	Obtém ou define a descrição localizada desse consumidor.
externalConfiguration	ExternalConfigurationDescriptor	Não nulo somente se as assinaturas desse consumidor estiverem configuradas externamente.
id	string	Obtém ou define o identificador desse consumidor.
imageUrl	string	Obtém ou define a URL de imagem desse consumidor, se houver.
informationUrl	string	Obtém ou define a URL de informações desse consumidor, se houver.
inputDescriptors	InputDescriptor[]	Obtém ou define os descritores de entrada desse consumidor.
name	string	Obtém ou define o nome localizado desse consumidor.
url	string	A URL deste recurso

ConsumerAction

Objeto

Define o contrato de dados de uma ação do consumidor.

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência
allowResourceVersionOverride	boolean	Obtém ou define o sinalizador que indica se a versão do recurso pode ser substituída ao criar ou editar uma assinatura.
consumerId	string	Obtém ou define o identificador do consumidor ao qual essa ação pertence.
description	string	Obtém ou define a descrição localizada dessa ação.
id	string	Obtém ou define o identificador dessa ação.
inputDescriptors	InputDescriptor[]	Obtém ou define os descritores de entrada dessa ação.
name	string	Obtém ou define o nome localizado dessa ação.
supportedEventTypes	string[]	Obtém ou define os identificadores de evento com suporte dessa ação.
supportedResourceVersions	object	Obtém ou define as versões de recurso com suporte dessa ação.
url	string	A URL deste recurso

ExternalConfigurationDescriptor

Objeto

Descreve como configurar uma assinatura gerenciada externamente.

Nome	Tipo	Description
createSubscriptionUrl	string	URL do site para criar esse tipo de assinatura.
editSubscriptionPropertyName	string	O nome de uma propriedade de entrada que contém a URL para editar uma assinatura.
hostedOnly	boolean	True se a configuração externa se aplicar somente ao hospedado.

InputDataType

Enumeração

Obtém ou define o tipo de dados a ser validado.

Valor	Description
boolean	Representa um valor verdadeiro ou falso.
guid	Representa um Guid.
none	Nenhum tipo de dados é especificado.
number	Representa um valor numérico.
string	Representa um valor textual.
uri	Representa um URI.

InputDescriptor

Objeto

Descreve uma entrada para assinaturas.

Nome	Tipo	Description
dependencyInputIds	string[]	As IDs de todas as entradas das quais o valor dessa entrada depende.
description	string	Descrição do que essa entrada é usada para
groupName	string	O nome localizado do grupo ao qual essa entrada pertence e pode ser mostrado como um cabeçalho para o contêiner que incluirá todas as entradas no grupo.
hasDynamicValueInformation	boolean	Se for true, as informações de valor dessa entrada serão dinâmicas e deverão ser buscadas quando o valor das entradas de dependência for alterado.
id	string	Identificador para a entrada da assinatura
inputMode	InputMode	Modo no qual o valor dessa entrada deve ser inserido
isConfidential	boolean	Obtém se essa entrada é confidencial, como para uma senha ou chave de aplicativo
name	string	Nome localizado que pode ser mostrado como um rótulo para a entrada da assinatura
properties	object	Propriedades personalizadas para a entrada que pode ser usada pelo provedor de serviços
type	string	Tipo de dados subjacente para o valor de entrada. Quando esse valor é especificado, InputMode, Validação e Valores são opcionais.
useInDefaultDescription	boolean	Obtém se essa entrada está incluída na descrição da ação gerada padrão.
validation	InputValidation	Informações a serem usadas para validar o valor dessa entrada
valueHint	string	Uma dica para o valor de entrada. Ele pode ser usado na interface do usuário como espaço reservado de entrada.
values	InputValues	Informações sobre valores possíveis para essa entrada

InputMode

Enumeração

Modo no qual o valor dessa entrada deve ser inserido

Valor	Description
checkBox	A caixa de seleção deve ser mostrada(para valores verdadeiros/falsos)
combo	Um controle select/combo deve ser mostrado
none	Essa entrada não deve ser mostrada na interface do usuário
passwordBox	Uma caixa de entrada de senha deve ser mostrada
radioButtons	Botões de opção devem ser mostrados
textArea	Uma área de texto de várias linhas deve ser mostrada
textBox	Uma caixa de texto de entrada deve ser mostrada

InputValidation

Objeto

Descreve quais valores são válidos para uma entrada de assinatura

Nome	Tipo	Description
dataType	InputDataType	Obtém ou define o tipo de dados a ser validado.
isRequired	boolean	Obtém ou define se esse é um campo necessário.
maxLength	integer (int32)	Obtém ou define o comprimento máximo desse descritor.
maxValue	string (decimal)	Obtém ou define o valor mínimo para esse descritor.
minLength	integer (int32)	Obtém ou define o comprimento mínimo desse descritor.
minValue	string (decimal)	Obtém ou define o valor mínimo para esse descritor.
pattern	string	Obtém ou define o padrão a ser validado.
patternMismatchErrorMessage	string	Obtém ou define o erro em incompatibilidade de padrões.

InputValue

Objeto

Informações sobre um único valor para uma entrada

Nome	Tipo	Description
data	object	Quaisquer outros dados sobre essa entrada
displayValue	string	O texto a ser mostrado para a exibição desse valor
value	string	O valor a ser armazenado para essa entrada

InputValues

Objeto

Informações sobre os valores possíveis/permitidos para uma determinada entrada de assinatura

Nome	Tipo	Description
defaultValue	string	O valor padrão a ser usado para esta entrada
error	InputValuesError	Erros encontrados durante a computação de valores dinâmicos.
inputId	string	A ID da entrada
isDisabled	boolean	Se essa entrada estiver desabilitada
isLimitedToPossibleValues	boolean	O valor deve ser restrito a um dos valores em PossibleValues (True) ou se os valores em PossibleValues são apenas uma sugestão (False)
isReadOnly	boolean	Se essa entrada for feita somente leitura
possibleValues	InputValue[]	Valores possíveis que essa entrada pode levar

InputValuesError

Objeto

Informações de erro relacionadas a um valor de entrada de assinatura.

Nome	Tipo	Description
message	string	A mensagem de erro.

ReferenceLinks

Objeto

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Partilhar via

Consumers - Get

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

Solicitação de exemplo

Resposta de exemplo

Definições

AuthenticationType

Consumer

ConsumerAction

ExternalConfigurationDescriptor

InputDataType

InputDescriptor

InputMode

InputValidation

InputValue

InputValues

InputValuesError

ReferenceLinks