Chemical Products - Get

服務:

Azure Data Manager for Agriculture

API 版本:

2023-11-01-preview

取得指定的化學產品資源。

GET {endpoint}/chemical-products/{chemicalProductId}?api-version=2023-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
chemicalProductId	path	True	string	化學產品的標識碼。
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
api-version	query	True	string	要求的 API 版本

要求標頭

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

回應

名稱	類型	Description
200 OK	ChemicalProduct	成功
Other Status Codes	ErrorResponse	[錯誤] 標題 x-ms-error-code: string

安全性

Authorization

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

類型: apiKey
位於: header

範例

ChemicalProducts_Get

範例要求

HTTP

GET {endpoint}/chemical-products/Chemical123?api-version=2023-11-01-preview

範例回覆

狀態碼:

200

{
  "id": "Chemical123",
  "cropIds": [
    "CropId"
  ],
  "reference": {
    "datasetId": "datasetId",
    "recordId": "recordId"
  },
  "brand": "Brand",
  "product": "AGTECH",
  "type": "Herbicide",
  "state": "Liquid",
  "activeIngredients": [
    "NO2"
  ],
  "specificGravity": "string",
  "formulation": "N, P, K",
  "company": {
    "name": "CompanyName",
    "description": "Agriculture Manufacturer",
    "registrationNumber": "1234"
  },
  "location": "US",
  "registrationNumber": "1234",
  "reEntryInterval": 5,
  "status": "Active",
  "source": "Manufacturer",
  "name": "Fertilizer1",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

定義

名稱	Description
ChemicalProduct	化學產品資源的架構。
Company	公司/製造商的詳細數據。
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 參考檔。
Reference	數據集記錄的參考。

ChemicalProduct

化學產品資源的架構。

名稱	類型	Description
activeIngredients	string[]	公式中的主動氣。
brand	string	化學產品的商業品牌。
company	Company	公司/製造商的詳細數據。
createdBy	string	由使用者/租使用者標識碼建立。
createdDateTime	string	建立資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
cropIds	string[]	與化學產品相關聯的裁剪標識符。 注意：最多 25 個裁剪可以與 cropProduct 相關聯。
description	string	資源的文字描述。
eTag	string	要實作開放式並行存取的ETag值。
formulation	string	公式描述。 N、P、K、CA、MG、S、FE、MN、ZN、CU、B、MO、CL (的百分比或其他單位，可用的化學元素可能會有所不同，但這是典型的清單) 。
id	string	唯一的資源標識碼。
location	string	使用化學的區域。 從合規性觀點來看，這很重要。
modifiedBy	string	由使用者/租使用者標識碼修改。
modifiedDateTime	string	上次修改資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用於識別資源的名稱。
product	string	化學產品的商業產品名稱。
properties		屬於資源的索引鍵值組集合。 每個配對的索引鍵不能大於 50 個字元，而且不能有大於 150 個字元的值。 注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和 datetime (yyyy-MM-ddTHH：mm：ssZ) 值。
reEntryInterval	integer	在套用化學產品之後，人員可以造訪欄位的天數。
reference	Reference	數據集記錄的參考。
registrationNumber	string	化學的註冊編號。 這可能會因地理位置而異。
source	string	資源的來源。
specificGravity	string	特定的重力詳細數據。
state	string	Liquid/non Liquid。
status	string	資源的狀態。
type	string	Herbicide、Additive、一個區區、一個區位，一個是一個。

Company

公司/製造商的詳細數據。

名稱	類型	Description
description	string	製造公司描述。
name	string	製造公司的名稱。
registrationNumber	string	公司的註冊號碼。

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 參考檔。

Reference

數據集記錄的參考。

名稱	類型	Description
datasetId	string	數據集標識碼。
recordId	string	記錄標識碼。