Subscriptions - Create Subscriptions Query

Ссылка

Service:: Service Hooks

API Version:: 7.1-preview.1

Запрос подписок на перехватчик служб.

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

Параметры URI

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

Текст запроса

Имя	Тип	Описание
consumerActionId	string	Необязательный идентификатор действия потребителя, ограничивающий результаты (null для любого)
consumerId	string	Необязательный идентификатор потребителя, ограничивающий результаты (null для любого)
consumerInputFilters	InputFilter[]	Фильтрация входных данных потребителя подписки
eventType	string	Необязательный идентификатор типа события, ограничивающий результаты (null для любого)
publisherId	string	Необязательный идентификатор издателя для ограничения результатов (null для любого)
publisherInputFilters	InputFilter[]	Фильтрация входных данных издателя подписки
results	Subscription[]	Результаты запроса
subscriberId	string	Необязательный фильтр подписчика.

Ответы

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

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

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	Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность искать код и получать уведомления о событиях управления версиями с помощью перехватчиков служб.

Определения

Имя	Описание
IdentityRef
InputFilter	Определяет фильтр для входных данных подписки. Фильтр соответствует набору входных данных, если для любой группы (одной или нескольких) задано значение true.
InputFilterCondition	Выражение, которое можно применить для фильтрации списка входных данных подписки.
InputFilterOperator	Оператор, применяемый между ожидаемым и фактическим входным значением
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
Subscription	Инкапсулирует подписку на события.
SubscriptionsQuery	Определяет запрос для подписок перехватчика служб.
SubscriptionStatus

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызывать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле будет уникальным образом определять один и тот же субъект графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое — можно получить запрос пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемое — можно получить запрос к состоянию членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links".
isAadIdentity	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Не рекомендуется — не используется в большинстве уже существовающих реализаций ToIdentityRef
uniqueName	string	Не рекомендуется использовать вместо него домен+principalName.
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

InputFilter

Определяет фильтр для входных данных подписки. Фильтр соответствует набору входных данных, если для любой группы (одной или нескольких) задано значение true.

Имя	Тип	Описание
conditions	InputFilterCondition[]	Группы выражений фильтра ввода. Этот фильтр соответствует набору входных данных, если какая-либо (одна или несколько) групп имеет значение true.

InputFilterCondition

Выражение, которое можно применить для фильтрации списка входных данных подписки.

Имя	Тип	Описание
caseSensitive	boolean	Указывает, следует ли выполнять сопоставление с учетом регистра
inputId	string	Идентификатор входных данных для фильтрации
inputValue	string	Ожидаемое входное значение для сравнения с фактическим входным значением
operator	InputFilterOperator	Оператор, применяемый между ожидаемым и фактическим входным значением

InputFilterOperator

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

Имя	Тип	Описание
equals	string
notEquals	string

ReferenceLinks

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

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

Subscription

Инкапсулирует подписку на события.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки для справки
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Входные значения потребителя
createdBy	IdentityRef
createdDate	string
eventDescription	string
eventType	string
id	string
lastProbationRetryDate	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	Входные значения издателя
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

SubscriptionsQuery

Определяет запрос для подписок перехватчика служб.

Имя	Тип	Описание
consumerActionId	string	Необязательный идентификатор действия потребителя, ограничивающий результаты (null для любого)
consumerId	string	Необязательный идентификатор потребителя, ограничивающий результаты (null для любого)
consumerInputFilters	InputFilter[]	Фильтрация входных данных потребителя подписки
eventType	string	Необязательный идентификатор типа события, ограничивающий результаты (null для любого)
publisherId	string	Необязательный идентификатор издателя для ограничения результатов (null для любого)
publisherInputFilters	InputFilter[]	Фильтрация входных данных издателя подписки
results	Subscription[]	Результаты запроса
subscriberId	string	Необязательный фильтр подписчика.

SubscriptionStatus

Имя	Тип	Описание
disabledByInactiveIdentity	string	Подписка отключена, так как владелец неактивен или у нее отсутствуют разрешения.
disabledBySystem	string	Подписка отключена системой.
disabledByUser	string	Подписка отключена пользователем.
enabled	string	Подписка включена.
onProbation	string	Подписка временно находится на испытательном сроке системой.

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