Sensor Partner Integrations - Create Or Update

  • リファレンス
サービス:
Azure Data Manager for Agriculture
API バージョン:
2023-11-01-preview

センサー パートナーとの統合を作成または更新します。

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/integrations/{integrationId}?api-version=2023-11-01-preview

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

uri

名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
integrationId
 path True

string

作成する統合の ID。
sensorPartnerId
 path True

string

センサー パートナーの ID。
api-version
 query True

string

要求された API バージョン

要求ヘッダー

Media Types: "application/merge-patch+json"

名前 必須 型 説明
Authorization True

string

承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

要求本文

Media Types: "application/merge-patch+json"

名前 型 説明
description

string

リソースの説明テキスト。
name

string

リソースを識別する名前
partyId

string

パーティの ID。
properties

リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。
status

string

リソースの状態。

応答

名前 型 説明
200 OK

SensorPartnerIntegrationModel

Success
201 Created

SensorPartnerIntegrationModel

作成済み
Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

SensorPartnerIntegrations_CreateOrUpdate

要求のサンプル

PATCH {endpoint}/sensor-partners/Davis/integrations/I123?api-version=2023-11-01-preview

{
  "partyId": "prbhad-party",
  "status": "string",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

応答のサンプル

状態コード:
200 
{
  "integrationId": "I123",
  "partyId": "prbhad-party",
  "sensorPartnerId": "Davis",
  "id": "I123",
  "status": "string",
  "createdDateTime": "2021-11-22T05:07:14Z",
  "modifiedDateTime": "2022-03-16T11:38:45Z",
  "eTag": "73023740-0000-0700-0000-6231cc450000",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}
状態コード:
201 
{
  "integrationId": "I123",
  "partyId": "prbhad-party",
  "sensorPartnerId": "Davis",
  "id": "I123",
  "status": "string",
  "createdDateTime": "2022-03-16T11:39:41Z",
  "modifiedDateTime": "2022-03-16T11:39:41Z",
  "eTag": "73023a53-0000-0700-0000-6231cc7d0000",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定義

名前 説明
Error

Azure AgPlatform サービスからのエラー。
ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
SensorPartnerIntegrationModel

センサー パートナー統合モデル。

Error

Azure AgPlatform サービスからのエラー。

名前 型 説明
code

string

サーバー定義のエラー コードのセット。
details

Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror

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

Error

Azure AgPlatform サービスからのエラー。
traceId

string

一意のトレース ID。

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

名前 型 説明
code

string

含まれているエラーによって提供されたエラーコードより具体的なエラー コード。
innererror

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

SensorPartnerIntegrationModel

センサー パートナー統合モデル。

名前 型 説明
createdBy

string

ユーザー/テナント ID によって作成されます。
createdDateTime

string

リソースが作成された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
description

string

リソースの説明テキスト。
eTag

string

オプティミスティック コンカレンシーを実装する ETag 値。
id

string

リソースの ID。
integrationId

string

統合の ID。
modifiedBy

string

ユーザー/テナント ID によって変更されました。
modifiedDateTime

string

リソースが最後に変更された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
name

string

リソースを識別する名前
partyId

string

パーティの ID。
properties

リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。
sensorPartnerId

string

関連付けられているセンサー パートナーの ID。
status

string

リソースの状態。