Publishers - Query Publishers
Запрос издателей перехватчиков служб.
POST https://dev.azure.com/{organization}/_apis/hooks/publishersquery?api-version=7.1-preview.1Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Название организации Azure DevOps. |
|
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| publisherIds |
string[] |
Необязательный список идентификаторов издателя для ограничения результатов |
| publisherInputs |
object |
Фильтрация входных данных издателя |
| results |
Результаты запроса |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
успешная операция |
Безопасность
oauth2
Тип:
oauth2
Flow:
accessCode
URL-адрес авторизации:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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
Области
| Имя | Описание |
|---|---|
| vso.work | Предоставляет возможность считывать рабочие элементы, запросы, доски, пути к областям и итерациям, а также другие метаданные, связанные с отслеживанием рабочих элементов. Кроме того, предоставляет возможность выполнять запросы, искать рабочие элементы и получать уведомления о событиях рабочих элементов через перехватчики служб. |
| vso.build | Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб. |
| vso.code | Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность искать код и получать уведомления о событиях управления версиями с помощью перехватчиков служб. |
Определения
| Имя | Описание |
|---|---|
|
Event |
Описывает тип события. |
|
Input |
Возвращает или задает тип данных для проверки. |
|
Input |
Описывает входные данные для подписок. |
|
Input |
Режим, в котором должно быть введено значение этого входного значения |
|
Input |
Описание допустимых значений для входных данных подписки |
|
Input |
Сведения об одном значении для входных данных |
|
Input |
Сведения о возможных и разрешенных значениях для входных данных подписки |
|
Input |
Сведения об ошибке, связанные с входным значением подписки. |
| Publisher |
Определяет контракт данных издателя событий. |
|
Publishers |
Определяет запрос для издателей перехватчиков служб. |
|
Reference |
Класс, представляющий коллекцию ссылок REST. |
EventTypeDescriptor
Описывает тип события.
| Имя | Тип | Описание |
|---|---|---|
| description |
string |
Локализованное описание типа события |
| id |
string |
Уникальный идентификатор для типа события. |
| inputDescriptors |
Входные данные для конкретных событий |
|
| name |
string |
Локализованное понятное имя для типа события |
| publisherId |
string |
Уникальный идентификатор издателя этого типа событий. |
| supportedResourceVersions |
string[] |
Поддерживаемые версии полезных данных ресурса события. |
| url |
string |
URL-адрес для этого ресурса |
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 |
Режим, в котором должно быть введено значение этого входного значения |
|
| isConfidential |
boolean |
Возвращает значение, указывающее, являются ли эти входные данные конфиденциальными, например для пароля или ключа приложения. |
| name |
string |
Локализованное имя, которое может отображаться в виде метки для входных данных подписки |
| properties |
object |
Настраиваемые свойства для входных данных, которые могут использоваться поставщиком услуг |
| type |
string |
Базовый тип данных для входного значения. Если это значение указано, InputMode, Validation и Values являются необязательными. |
| useInDefaultDescription |
boolean |
Возвращает значение, указывающее, включены ли эти входные данные в созданное по умолчанию описание действия. |
| validation |
Сведения, используемые для проверки значения этого входного значения |
|
| valueHint |
string |
Указание для входного значения. Его можно использовать в пользовательском интерфейсе в качестве заполнителя входных данных. |
| values |
Сведения о возможных значениях для этих входных данных |
InputMode
Режим, в котором должно быть введено значение этого входного значения
| Имя | Тип | Описание |
|---|---|---|
| checkBox |
string |
Должен отображаться флажок (для значений true/false) |
| combo |
string |
Должен отображаться элемент управления select/combo |
| none |
string |
Эти входные данные не должны отображаться в пользовательском интерфейсе |
| passwordBox |
string |
Должно появиться поле ввода пароля |
| radioButtons |
string |
Должны отображаться переключатели |
| textArea |
string |
Должна отображаться многострочный текст |
| textBox |
string |
Должно отображаться текстовое поле ввода |
InputValidation
Описание допустимых значений для входных данных подписки
| Имя | Тип | Описание |
|---|---|---|
| dataType |
Возвращает или задает тип данных для проверки. |
|
| 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 |
Ошибки, возникшие при вычислении динамических значений. |
|
| inputId |
string |
Идентификатор входных данных |
| isDisabled |
boolean |
Если этот вход отключен |
| isLimitedToPossibleValues |
boolean |
Значение должно быть ограничено одним из значений в PossibleValues (True) или является ли значение в PossibleValues только предложением (False) |
| isReadOnly |
boolean |
Если эти входные данные доступны только для чтения |
| possibleValues |
Возможные значения, которые могут принимать эти входные данные |
InputValuesError
Сведения об ошибке, связанные с входным значением подписки.
| Имя | Тип | Описание |
|---|---|---|
| message |
string |
Сообщение об ошибке. |
Publisher
Определяет контракт данных издателя событий.
| Имя | Тип | Описание |
|---|---|---|
| _links |
Ссылки для справки |
|
| description |
string |
Возвращает локализованное описание этого издателя. |
| id |
string |
Возвращает идентификатор издателя. |
| inputDescriptors |
Входные данные издателя |
|
| name |
string |
Возвращает локализованное имя этого издателя. |
| serviceInstanceType |
string |
Тип экземпляра службы стороннего издателя. |
| supportedEvents |
Возвращает поддерживаемые типы событий этого издателя. |
|
| url |
string |
URL-адрес для этого ресурса |
PublishersQuery
Определяет запрос для издателей перехватчиков служб.
| Имя | Тип | Описание |
|---|---|---|
| publisherIds |
string[] |
Необязательный список идентификаторов издателя для ограничения результатов |
| publisherInputs |
object |
Фильтрация входных данных издателя |
| results |
Результаты запроса |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
| Имя | Тип | Описание |
|---|---|---|
| links |
object |
Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения. |