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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	要建立之整合的標識碼。
sensorPartnerId	path	True	string	感測器合作夥伴的標識碼。
api-version	query	True	string	要求的 API 版本

要求標頭

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

名稱	必要	類型	Description
Authorization	True	string	請為授權的 API 呼叫提供有效的持有人令牌。 請注意，如果您之前嘗試了未驗證的呼叫，您可能需要清除瀏覽器快取。

要求本文

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

名稱	類型	Description
description	string	資源的文字描述。
name	string	用於識別資源的名稱。
partyId	string	合作對象的標識碼。
properties		屬於資源的索引鍵值組集合。 每個配對不能有大於 50 個字元的索引鍵，而且不能有大於 150 個字元的值。 注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和日期時間 (yyyy-MM-ddTHH：mm：ssZ) 值。
status	string	資源的狀態。

回應

名稱	類型	Description
200 OK	SensorPartnerIntegrationModel	成功
201 Created	SensorPartnerIntegrationModel	建立時間
Other Status Codes	ErrorResponse	[錯誤] 標題 x-ms-error-code: string

安全性

Authorization

請為授權的 API 呼叫提供有效的持有人令牌。 請注意，如果您之前嘗試了未驗證的呼叫，您可能需要清除瀏覽器快取。

類型: apiKey
位於: header

範例

SensorPartnerIntegrations_CreateOrUpdate

範例要求

HTTP

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
  }
}

定義

名稱	Description
Error	來自 Azure AgPlatform 服務的錯誤。
ErrorResponse	來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。
InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
SensorPartnerIntegrationModel	感測器合作夥伴整合模型。

Error

來自 Azure AgPlatform 服務的錯誤。

名稱	類型	Description
code	string	伺服器定義的錯誤碼集。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
message	string	人類可閱讀的錯誤表示法。
target	string	錯誤的目標。

ErrorResponse

來自 Azure AgPlatform 服務的錯誤回應。 請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。

名稱	類型	Description
error	Error	來自 Azure AgPlatform 服務的錯誤。
traceId	string	唯一追蹤標識碼。

InnerError

包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

名稱	類型	Description
code	string	包含錯誤所提供的特定錯誤碼。
innererror	InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

SensorPartnerIntegrationModel

感測器合作夥伴整合模型。

名稱	類型	Description
createdBy	string	由使用者/租使用者標識碼建立。
createdDateTime	string	建立資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
description	string	資源的文字描述。
eTag	string	要實作開放式並行存取的ETag值。
id	string	資源的標識碼。
integrationId	string	整合的標識碼。
modifiedBy	string	由使用者/租使用者標識碼修改。
modifiedDateTime	string	上次修改資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用於識別資源的名稱。
partyId	string	合作對象的標識碼。
properties		屬於資源的索引鍵值組集合。 每個配對不能有大於 50 個字元的索引鍵，而且不能有大於 150 個字元的值。 注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和日期時間 (yyyy-MM-ddTHH：mm：ssZ) 值。
sensorPartnerId	string	相關聯感測器夥伴的標識碼。
status	string	資源的狀態。