Consumers - Get

Ссылка

Service:: Service Hooks

API Version:: 7.1-preview.1

Получение определенной службы потребителя. При необходимости отфильтруйте действия потребителей, которые не поддерживают типы событий для указанного издателя.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
consumerId	path	True	string	Идентификатор потребителя.
organization	path	True	string	Название организации Azure DevOps.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.
publisherId	query		string

Ответы

Имя	Тип	Описание
200 OK	Consumer	успешная операция

Безопасность

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

Имя	Описание
vso.work	Предоставляет возможность чтения рабочих элементов, запросов, досок, путей областей и итераций, а также других метаданных, связанных с отслеживанием рабочих элементов. Также предоставляет возможность выполнять запросы, искать рабочие элементы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.
vso.build	Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб.
vso.code	Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Также предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Примеры

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

Определения

Имя	Описание
AuthenticationType	Возвращает или задает тип проверки подлинности этого потребителя.
Consumer	Определяет контракт данных потребителя.
ConsumerAction	Определяет контракт данных действия потребителя.
ExternalConfigurationDescriptor	Описывает настройку подписки, управляемой извне.
InputDataType	Возвращает или задает тип данных для проверки.
InputDescriptor	Описывает входные данные для подписок.
InputMode	Режим, в котором должно быть введено значение этого входного значения
InputValidation	Описание допустимых значений для входных данных подписки
InputValue	Сведения об одном значении для входных данных
InputValues	Сведения о возможных и допустимых значениях для входных данных для определенной подписки
InputValuesError	Сведения об ошибке, связанные с входным значением подписки.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.

AuthenticationType

Возвращает или задает тип проверки подлинности этого потребителя.

Имя	Тип	Описание
external	string	Проверка подлинности, настроенная извне.
none	string	Проверка подлинности не требуется.
oAuth	string	Проверка подлинности OAuth.

Consumer

Определяет контракт данных потребителя.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки для справки
actions	ConsumerAction[]	Возвращает действия этого потребителя.
authenticationType	AuthenticationType	Возвращает или задает тип проверки подлинности этого потребителя.
description	string	Возвращает или задает локализованное описание этого потребителя.
externalConfiguration	ExternalConfigurationDescriptor	Не равно NULL, только если подписки для этого потребителя настроены извне.
id	string	Возвращает или задает идентификатор этого потребителя.
imageUrl	string	Возвращает или задает URL-адрес изображения этого потребителя, если таковой есть.
informationUrl	string	Возвращает или задает URL-адрес сведений этого потребителя, если он есть.
inputDescriptors	InputDescriptor[]	Возвращает или задает входные дескрипторы этого потребителя.
name	string	Возвращает или задает локализованное имя этого потребителя.
url	string	URL-адрес этого ресурса

ConsumerAction

Определяет контракт данных действия потребителя.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки для справки
allowResourceVersionOverride	boolean	Возвращает или задает флаг, указывающий, можно ли переопределить версию ресурса при создании или изменении подписки.
consumerId	string	Возвращает или задает идентификатор потребителя, которому принадлежит данное действие.
description	string	Возвращает или задает локализованное описание этого действия.
id	string	Возвращает или задает идентификатор этого действия.
inputDescriptors	InputDescriptor[]	Возвращает или задает входные дескрипторы этого действия.
name	string	Возвращает или задает локализованное имя этого действия.
supportedEventTypes	string[]	Возвращает или задает поддерживаемые идентификаторы событий этого действия.
supportedResourceVersions	object	Возвращает или задает поддерживаемые версии ресурсов этого действия.
url	string	URL-адрес этого ресурса

ExternalConfigurationDescriptor

Описывает настройку подписки, управляемой извне.

Имя	Тип	Описание
createSubscriptionUrl	string	URL-адрес сайта для создания подписки этого типа.
editSubscriptionPropertyName	string	Имя входного свойства, содержащего URL-адрес для изменения подписки.
hostedOnly	boolean	Значение true, если внешняя конфигурация применяется только к размещенной.

InputDataType

Возвращает или задает тип данных для проверки.

Имя	Тип	Описание
boolean	string	Представляет значение true или false.
guid	string	Представляет guid.
none	string	Тип данных не указан.
number	string	Представляет числовое значение.
string	string	Представляет текстовое значение.
uri	string	Представляет универсальный код ресурса (URI).

InputDescriptor

Описывает входные данные для подписок.

Имя	Тип	Описание
dependencyInputIds	string[]	Идентификаторы всех входных данных, от которые зависит значение этих входных данных.
description	string	Описание того, для чего используются эти входные данные
groupName	string	Локализованное имя группы, к которому принадлежат эти входные данные, может отображаться в качестве заголовка для контейнера, который будет включать все входные данные в группе.
hasDynamicValueInformation	boolean	Если значение равно true, сведения о значении для этих входных данных являются динамическими и должны быть извлекаемы при изменении значения входных данных зависимостей.
id	string	Идентификатор входных данных подписки
inputMode	InputMode	Режим, в котором должно быть введено значение этого входного значения
isConfidential	boolean	Возвращает значение, указывающее, являются ли эти входные данные конфиденциальными, например для пароля или ключа приложения.
name	string	Локализованное имя, которое может отображаться в виде метки для входных данных подписки
properties	object	Пользовательские свойства для входных данных, которые могут использоваться поставщиком услуг
type	string	Базовый тип данных для входного значения. Если указано это значение, InputMode, Validation и Values являются необязательными.
useInDefaultDescription	boolean	Возвращает значение, указывающее, включены ли эти входные данные в описание созданного по умолчанию действия.
validation	InputValidation	Сведения, используемые для проверки значения входных данных
valueHint	string	Указание для входного значения. Его можно использовать в пользовательском интерфейсе в качестве заполнителя входных данных.
values	InputValues	Сведения о возможных значениях для этих входных данных

InputMode

Режим, в котором должно быть введено значение этого входного значения

Имя	Тип	Описание
checkBox	string	Должен отображаться флажок (для значений true/false)
combo	string	Должен отображаться элемент управления select/combo
none	string	Эти входные данные не должны отображаться в пользовательском интерфейсе
passwordBox	string	Должно появиться поле ввода пароля
radioButtons	string	Должны отображаться переключатели
textArea	string	Должна отображаться многострочный текст
textBox	string	Должно отображаться текстовое поле ввода

InputValidation

Описание допустимых значений для входных данных подписки

Имя	Тип	Описание
dataType	InputDataType	Возвращает или задает тип данных для проверки.
isRequired	boolean	Возвращает или задает значение , если это обязательное поле.
maxLength	integer	Возвращает или задает максимальную длину этого дескриптора.
maxValue	string	Возвращает или задает минимальное значение для этого дескриптора.
minLength	integer	Возвращает или задает минимальную длину этого дескриптора.
minValue	string	Возвращает или задает минимальное значение для этого дескриптора.
pattern	string	Возвращает или задает проверяемую схему.
patternMismatchErrorMessage	string	Возвращает или задает ошибку при несоответствии шаблона.

InputValue

Сведения об одном значении для входных данных

Имя	Тип	Описание
data	object	Любые другие данные об этих входных данных
displayValue	string	Текст, отображаемый для отображения этого значения
value	string	Значение, которое нужно сохранить для этих входных данных

InputValues

Сведения о возможных и допустимых значениях для входных данных для определенной подписки

Имя	Тип	Описание
defaultValue	string	Значение по умолчанию, используемое для этих входных данных
error	InputValuesError	Ошибки, возникшие при вычислении динамических значений.
inputId	string	Идентификатор входных данных
isDisabled	boolean	Если эти входные данные отключены
isLimitedToPossibleValues	boolean	Значение должно быть ограничено одним из значений в Элементе PossibleValues (True) или является ли значением в PossibleValues только предложение (False)
isReadOnly	boolean	Если эти входные данные доступны только для чтения
possibleValues	InputValue[]	Возможные значения, которые могут принимать эти входные данные

InputValuesError

Сведения об ошибке, связанные с входным значением подписки.

Имя	Тип	Описание
message	string	Сообщение об ошибке.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

Поделиться через