Consumers - Get

リファレンス

サービス:: Service Hooks

API バージョン:: 7.1

特定のコンシューマーサービスを取得します。必要に応じて、指定した発行元のイベントの種類をサポートしていないコンシューマーアクションを除外します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
consumerId	path	True	string	コンシューマーの ID。
organization	path	True	string	Azure DevOps 組織の名前。
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
publisherId	query		string

応答

名前	型	説明
200 OK	Consumer	成功した操作

セキュリティ

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

スコープ

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

例

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 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	入力の 1 つの値に関する情報
InputValues	特定のサブスクリプション入力で使用可能/許可される値に関する情報
InputValuesError	サブスクリプションの入力値に関連するエラー情報。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。

AuthenticationType

列挙

このコンシューマーの認証の種類を取得または設定します。

値	説明
external	外部で構成された認証。
none	認証は必要ありません。
oAuth	OAuth 認証。

Consumer

Object

コンシューマーのデータコントラクトを定義します。

名前	型	説明
_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

Object

コンシューマーアクションのデータコントラクトを定義します。

名前	型	説明
_links	ReferenceLinks	参照リンク
allowResourceVersionOverride	boolean	サブスクリプションの作成時または編集時にリソースのバージョンをオーバーライドできるかどうかを示すフラグを取得または設定します。
consumerId	string	このアクションが属するコンシューマーの識別子を取得または設定します。
description	string	このアクションのローカライズされた説明を取得または設定します。
id	string	このアクションの識別子を取得または設定します。
inputDescriptors	InputDescriptor[]	このアクションの入力記述子を取得または設定します。
name	string	このアクションのローカライズされた名前を取得または設定します。
supportedEventTypes	string[]	このアクションでサポートされているイベント識別子を取得または設定します。
supportedResourceVersions	object	このアクションでサポートされているリソースバージョンを取得または設定します。
url	string	このリソースの URL

ExternalConfigurationDescriptor

Object

外部で管理されるサブスクリプションを構成する方法について説明します。

名前	型	説明
createSubscriptionUrl	string	この種類のサブスクリプションを作成するサイトの URL。
editSubscriptionPropertyName	string	サブスクリプションを編集するための URL を含む入力プロパティの名前。
hostedOnly	boolean	True の場合は、外部構成がホステッドにのみ適用されます。

InputDataType

列挙

検証するデータ型を取得または設定します。

値	説明
boolean	true または false の値を表します。
guid	Guid を表します。
none	データ型は指定されません。
number	数値を表します。
string	テキスト値を表します。
uri	URI を表します。

InputDescriptor

Object

サブスクリプションの入力について説明します。

名前	型	説明
dependencyInputIds	string[]	この入力の値が依存しているすべての入力の ID。
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	入力値のヒント。入力プレースホルダーとして UI で使用できます。
values	InputValues	この入力に使用できる値に関する情報

InputMode

列挙

この入力の値を入力するモード

値	説明
checkBox	チェックボックスを表示する必要があります (true/false 値の場合)
combo	選択/コンボコントロールを表示する必要がある
none	この入力は UI に表示されません
passwordBox	パスワード入力ボックスが表示されます
radioButtons	ラジオボタンを表示する必要がある
textArea	複数行のテキスト領域を表示する必要がある
textBox	入力テキストボックスが表示されます

InputValidation

Object

サブスクリプション入力に対して有効な値について説明します

名前	型	説明
dataType	InputDataType	検証するデータ型を取得または設定します。
isRequired	boolean	これが必須フィールドかどうかを取得または設定します。
maxLength	integer (int32)	この記述子の最大長を取得または設定します。
maxValue	string (decimal)	この記述子の最小値を取得または設定します。
minLength	integer (int32)	この記述子の最小長を取得または設定します。
minValue	string (decimal)	この記述子の最小値を取得または設定します。
pattern	string	検証するパターンを取得または設定します。
patternMismatchErrorMessage	string	パターンの不一致に関するエラーを取得または設定します。

InputValue

Object

入力の 1 つの値に関する情報

名前	型	説明
data	object	この入力に関するその他のデータ
displayValue	string	この値を表示するために表示するテキスト
value	string	この入力に格納する値

InputValues

Object

特定のサブスクリプション入力で使用可能/許可される値に関する情報

名前	型	説明
defaultValue	string	この入力に使用する既定値
error	InputValuesError	動的な値の計算中に発生したエラー。
inputId	string	入力の ID
isDisabled	boolean	この入力を無効にする必要がある場合
isLimitedToPossibleValues	boolean	値が PossibleValues (True) のいずれかの値に制限されている場合、または PossibleValues の値が単なる候補 (False) の場合
isReadOnly	boolean	この入力を読み取り専用にする必要がある場合
possibleValues	InputValue[]	この入力で使用できる値

InputValuesError

Object

サブスクリプションの入力値に関連するエラー情報。

名前	型	説明
message	string	エラーメッセージ。

ReferenceLinks

Object

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

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

次の方法で共有

Consumers - Get

URI パラメーター

応答

セキュリティ

oauth2

スコープ

例

要求のサンプル

応答のサンプル

定義

AuthenticationType

Consumer

ConsumerAction

ExternalConfigurationDescriptor

InputDataType

InputDescriptor

InputMode

InputValidation

InputValue

InputValues

InputValuesError

ReferenceLinks