Crops - Get

服務:

Azure Data Manager for Agriculture

API 版本:

2023-11-01-preview

取得指定的裁剪資源。

GET {endpoint}/crops/{cropId}?api-version=2023-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
cropId	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	Crop	成功
Other Status Codes	ErrorResponse	錯誤 標題 x-ms-error-code: string

安全性

Authorization

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

類型: apiKey
位於: header

範例

Crops_Get

範例要求

HTTP

GET {endpoint}/crops/CORN123?api-version=2023-11-01-preview

範例回覆

狀態碼:

200

{
  "id": "CORN123",
  "phenotype": "Corn",
  "breedingMethod": "VARIETY",
  "measurements": {
    "m1": {
      "unit": "string",
      "value": 0
    },
    "m2": {
      "unit": "string",
      "value": 0
    },
    "m3": {
      "unit": "string",
      "value": 0
    }
  },
  "name": "John Smith's Crop",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "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
Crop	裁剪資源的架構。
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。
Measure	用於儲存測量讀取和單位的架構。
Reference	數據集記錄的參考。

Crop

Object

裁剪資源的架構。

名稱	類型	Description
breedingMethod	string	品種、雜交、未知等育種方法類型。
createdBy	string	由使用者/租使用者標識碼建立。
createdDateTime	string (date-time)	建立資源的日期時間，範例格式：yyyy-MM-ddTHH：mm：ssZ。
description	string minLength: 0 maxLength: 500	資源的文字描述。
eTag	string	要實作開放式並行存取的ETag值。
id	string	唯一的資源標識碼。
location	string minLength: 0 maxLength: 50	種植作物的區域。
measurements	<string,  Measure>	與這個作物相關的屬性，例如名義重量、名義濕度和收縮因數。
modifiedBy	string	由使用者/租使用者標識碼修改。
modifiedDateTime	string (date-time)	上次修改資源的日期時間，範例格式：yyyy-MM-ddTHH：mm：ssZ。
name	string minLength: 0 maxLength: 100	用來識別資源的名稱。
phenotype	string minLength: 0 maxLength: 100	作物的表型。 範例值包括裁剪粗細、高度、色彩等。
properties		屬於資源的索引鍵值組集合。 每個配對不能有大於 50 個字元的索引鍵，而且不能有大於 150 個字元的值。 注意：最多可以針對資源提供 25 個索引鍵值組，而且只支援字串、數位和日期時間 （yyyy-MM-ddTHH：mm：ssZ） 值。
reference	Reference	數據集記錄的參考。
source	string minLength: 2 maxLength: 100	資源的來源。
status	string minLength: 0 maxLength: 100	資源的狀態。

Error

Object

來自 Azure AgPlatform 服務的錯誤。

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

ErrorResponse

Object

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

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

InnerError

Object

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

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

Measure

Object

用於儲存測量讀取和單位的架構。

名稱	類型	Description
unit	string minLength: 1 maxLength: 50	數據單位。
value	number (double)	數據值。

Reference

Object

數據集記錄的參考。

名稱	類型	Description
datasetId	string minLength: 0 maxLength: 100	數據集標識碼。
recordId	string minLength: 0 maxLength: 100	記錄標識碼。