Subscriptions - Create Subscriptions Query

サービス フック サブスクリプションのクエリを実行します。

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

URI パラメーター

Name / 必須 型 説明
organization
path True

string

Azure DevOps 組織の名前。

api-version
query True

string

使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。

要求本文

Name 型 説明
consumerActionId

string

結果を (任意の場合は null) に制限するオプションのコンシューマー アクション ID

consumerId

string

結果を制限するオプションのコンシューマー ID (任意の場合は null)

consumerInputFilters

InputFilter[]

サブスクリプション コンシューマーの入力をフィルター処理する

eventType

string

結果を (任意の場合は null) に制限するオプションのイベント型 ID

publisherId

string

結果を (任意の場合は null) に制限する省略可能な発行元 ID

publisherInputFilters

InputFilter[]

サブスクリプションの発行元の入力をフィルター処理する

results

Subscription[]

クエリからの結果

subscriberId

string (uuid)

オプションのサブスクライバー フィルター。

応答

Name 型 説明
200 OK

SubscriptionsQuery

成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

Name 説明
vso.work 作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、クエリを実行したり、作業項目を検索したり、サービス フックを介して作業項目イベントに関する通知を受信したりすることもできます。
vso.build ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、サービス フックを介してビルド イベントに関する通知を受信する機能を付与します。
vso.code コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソース コードとメタデータを読み取る機能を付与します。 また、コードを検索し、サービス フックを使用してバージョン管理イベントに関する通知を受け取る機能も付与されます。

定義

Name 説明
IdentityRef
InputFilter

サブスクリプション入力のフィルターを定義します。 グループの 1 つ以上が true と評価された場合、フィルターは入力のセットと一致します。

InputFilterCondition

サブスクリプション入力の一覧をフィルター処理するために適用できる式

InputFilterOperator

予期される入力値と実際の入力値の間に適用される演算子

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

Subscription

イベント サブスクリプションをカプセル化します。

SubscriptionsQuery

サービス フック サブスクリプションのクエリを定義します。

SubscriptionStatus

IdentityRef

Name 型 説明
_links

ReferenceLinks

このフィールドには、グラフの件名に関する興味深いリンクが 0 個以上含まれています。 これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップや詳細情報を取得できます。

descriptor

string

記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。

directoryAlias

string

非推奨 - IdentityRef "_links" ディクショナリの "自己" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます

displayName

string

これは、グラフの件名の一意でない表示名です。 このフィールドを変更するには、ソース プロバイダーでその値を変更する必要があります。

id

string

imageUrl

string

非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます

inactive

boolean

非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます

isAadIdentity

boolean

非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます

isContainer

boolean

非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます

isDeletedInOrigin

boolean

profileUrl

string

非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません

uniqueName

string

非推奨 - 代わりに Domain+PrincipalName を使用する

url

string

この URL は、このグラフの件名のソース リソースへの完全なルートです。

InputFilter

サブスクリプション入力のフィルターを定義します。 グループの 1 つ以上が true と評価された場合、フィルターは入力のセットと一致します。

Name 型 説明
conditions

InputFilterCondition[]

入力フィルター式のグループ。 このフィルターは、グループのいずれかの (1 つ以上) が true と評価された場合に、入力のセットと一致します。

InputFilterCondition

サブスクリプション入力の一覧をフィルター処理するために適用できる式

Name 型 説明
caseSensitive

boolean

大文字と小文字が区別される一致を行うかどうか

inputId

string

フィルター処理する入力の ID

inputValue

string

実際の入力値と比較する "予期される" 入力値

operator

InputFilterOperator

予期される入力値と実際の入力値の間に適用される演算子

InputFilterOperator

予期される入力値と実際の入力値の間に適用される演算子

値 説明
equals
notEquals

REST 参照リンクのコレクションを表すクラス。

Name 型 説明
links

object

リンクの読み取りビュー。 参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

Subscription

イベント サブスクリプションをカプセル化します。

Name 型 説明
_links

ReferenceLinks

参照リンク

actionDescription

string

consumerActionId

string

consumerId

string

consumerInputs

object

コンシューマーの入力値

createdBy

IdentityRef

createdDate

string (date-time)

eventDescription

string

eventType

string

id

string (uuid)

lastProbationRetryDate

string (date-time)

modifiedBy

IdentityRef

modifiedDate

string (date-time)

probationRetries

string (byte)

publisherId

string

publisherInputs

object

発行元の入力値

resourceVersion

string

status

SubscriptionStatus

subscriber

IdentityRef

url

string

SubscriptionsQuery

サービス フック サブスクリプションのクエリを定義します。

Name 型 説明
consumerActionId

string

結果を (任意の場合は null) に制限するオプションのコンシューマー アクション ID

consumerId

string

結果を制限するオプションのコンシューマー ID (任意の場合は null)

consumerInputFilters

InputFilter[]

サブスクリプション コンシューマーの入力をフィルター処理する

eventType

string

結果を (任意の場合は null) に制限するオプションのイベント型 ID

publisherId

string

結果を (任意の場合は null) に制限する省略可能な発行元 ID

publisherInputFilters

InputFilter[]

サブスクリプションの発行元の入力をフィルター処理する

results

Subscription[]

クエリからの結果

subscriberId

string (uuid)

オプションのサブスクライバー フィルター。

SubscriptionStatus

値 説明
enabled

サブスクリプションが有効になっています。

onProbation

サブスクリプションは、システムによって一時的に保護観察中です。

disabledByUser

サブスクリプションはユーザーによって無効になっています。

disabledBySystem

サブスクリプションはシステムによって無効になっています。

disabledByInactiveIdentity

所有者が非アクティブであるか、アクセス許可がないため、サブスクリプションは無効になります。