Sensor Partner Integrations - Check Consent
パートナー統合の同意を確認します。
POST {endpoint}/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent?key={key}&api-version=2023-11-01-previewURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string uri |
名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net) |
|
integration
|
path | True |
string |
統合オブジェクトの ID。 |
|
sensor
|
path | True |
string |
センサー パートナーの ID。 |
|
api-version
|
query | True |
string |
要求された API バージョン |
|
key
|
query | True |
string |
パートナー統合キー。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Authorization | True |
string |
承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Success |
|
| Other Status Codes |
エラー ヘッダー x-ms-error-code: string |
セキュリティ
Authorization
承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。
型:
apiKey
/:
header
例
SensorPartnerIntegrations_CheckConsent
要求のサンプル
POST {endpoint}/sensor-partners/Davis/integrations/I123/:check-consent?key=CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8&api-version=2023-11-01-preview
応答のサンプル
{
"consented": true,
"sensorPartnerId": "Davis",
"integrationId": "I123"
}定義
| 名前 | 説明 |
|---|---|
| Error |
Azure AgPlatform サービスからのエラー。 |
|
Error |
Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。 |
|
Inner |
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
|
Sensor |
センサー パートナー統合チェック同意応答。 |
Error
Azure AgPlatform サービスからのエラー。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義のエラー コードのセット。 |
| details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
| innererror |
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
|
| message |
string |
人が判読できるエラーの表現。 |
| target |
string |
エラーのターゲット。 |
ErrorResponse
Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
Azure AgPlatform サービスからのエラー。 |
|
| traceId |
string |
一意のトレース ID。 |
InnerError
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
含まれているエラーによって提供されたエラーコードより具体的なエラー コード。 |
| innererror |
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
SensorPartnerIntegrationCheckConsentResponse
センサー パートナー統合チェック同意応答。
| 名前 | 型 | 説明 |
|---|---|---|
| consented |
boolean |
パートナー統合の同意の状態を決定するフラグ。 |
| integrationId |
string |
統合の ID。 |
| sensorPartnerId |
string |
関連付けられているセンサー パートナーの ID。 |