Fields - Search

參考

服務:: Azure Data Manager for Agriculture

API 版本:: 2023-11-01-preview

透過交集幾何來搜尋所有合作物件的欄位。

POST {endpoint}/fields:search?api-version=2023-11-01-preview

含選擇性參數:

POST {endpoint}/fields:search?skipToken={skipToken}&maxPageSize={maxPageSize}&api-version=2023-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
api-version	query	True	string	要求的 API 版本
maxPageSize	query		integer int32	包含) (所需的項目數目上限。最小值 = 10，最大值 = 1000，預設值 = 50。
skipToken	query		string	略過令牌以取得下一組結果。

要求標頭

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

要求本文

名稱	類型	Description
farmIds	string[]	資源的 FarmId。
ids	string[]	資源的標識碼。
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (如需詳細資訊： https://geojson.org/) 。注意：坐標必須是 [經度、緯度] 格式。
maxCreatedDateTime	string	資源 (內含) 的建立日期上限。
maxLastModifiedDateTime	string	資源 (內含) 的上次修改日期上限。
minCreatedDateTime	string	資源 (內含) 的最低建立日期。
minLastModifiedDateTime	string	資源 (內含) 的上次修改日期下限。
names	string[]	資源的名稱。
partyId	string	屬於作業數據的合作物件標識碼。
propertyFilters	string[]	篩選 Properties 物件內的索引鍵/值組。例如“{testKey} eq {testValue}”。
statuses	string[]	資源的狀態。

回應

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

名稱

類型

Description

200 OK

FieldMetaDataListResponse

成功

Other Status Codes

ErrorResponse

[錯誤]

標題

x-ms-error-code: string

安全性

Authorization

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

類型: apiKey
位於: header

範例

Fields_Search

範例要求

HTTP

POST {endpoint}/fields:search?maxPageSize=50&api-version=2023-11-01-preview

{
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  }
}

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "FIELD123",
      "partyId": "FARMER123",
      "farmId": "FARM123",
      "name": "John Smith's Field",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

定義

名稱	Description
Error	來自 Azure AgPlatform 服務的錯誤。
ErrorResponse	來自 Azure AgPlatform 服務的錯誤回應。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 參考檔。
FieldMetaData	欄位資源的架構。
FieldMetaDataListResponse	分頁回應包含要求的物件清單，以及skipToken以取得下一組結果。
GeoJsonObjectType	GeoJSON 物件類型。
InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。
MultiPolygon	MultiPolygon 幾何。
Point	點幾何。
Polygon	多邊形幾何。
SearchFieldQuery	SearchAllBoundaries 和 SearchBoundaries 參數。

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	唯一追蹤標識碼。

FieldMetaData

欄位資源的架構。

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

FieldMetaDataListResponse

分頁回應包含要求的物件清單，以及skipToken以取得下一組結果。

名稱	類型	Description
nextLink	string	清單中下一個結果頁面的接續連結 (絕對 URI)。
skipToken	string	用於擷取下一頁的令牌。如果為 null，則沒有任何其他頁面。
value	FieldMetaData[]	要求的物件清單。

GeoJsonObjectType

GeoJSON 物件類型。

名稱	類型	Description
MultiPolygon	string
Point	string
Polygon	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 參考檔。

MultiPolygon

MultiPolygon 幾何。

名稱	類型	Description
coordinates	number[]	取得或設定 GeoJSON 物件的座標。它必須是多邊形的陣列，每個多邊形都包含線性環形的清單。針對具有多個環形的多邊形，第一個必須是外部環形，而任何其他必須是內部環形。
type	string: MultiPolygon	GeoJSON 物件類型。

Point

點幾何。

名稱	類型	Description
coordinates	number[]	取得或設定這個點的座標。它必須是 2D 或 3D 系統的 2 或 3 元素陣列。
type	string: Point	GeoJSON 物件類型。

Polygon

多邊形幾何。

名稱	類型	Description
coordinates	number[]	取得或設定 GeoJSON 物件的類型。它必須是線性環形座標數位的陣列。針對具有多個環形的多邊形，第一個必須是外部環形，而任何其他必須是內部環形。
type	string: Polygon	GeoJSON 物件類型。

SearchFieldQuery

SearchAllBoundaries 和 SearchBoundaries 參數。

名稱	類型	Description
farmIds	string[]	資源的 FarmId。
ids	string[]	資源的標識碼。
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (如需詳細資訊： https://geojson.org/) 。注意：坐標必須是 [經度、緯度] 格式。
maxCreatedDateTime	string	資源 (內含) 的建立日期上限。
maxLastModifiedDateTime	string	資源 (內含) 的上次修改日期上限。
minCreatedDateTime	string	資源 (內含) 的最低建立日期。
minLastModifiedDateTime	string	資源 (內含) 的上次修改日期下限。
names	string[]	資源的名稱。
partyId	string	屬於作業數據的合作物件標識碼。
propertyFilters	string[]	篩選 Properties 物件內的索引鍵/值組。例如“{testKey} eq {testValue}”。
statuses	string[]	資源的狀態。

共用方式為

Fields - Search

URI 參數

要求標頭

要求本文

回應

安全性

Authorization

範例

Fields_Search

範例要求

範例回覆

定義

Error

ErrorResponse

FieldMetaData

FieldMetaDataListResponse

GeoJsonObjectType

InnerError

MultiPolygon

Point

Polygon

SearchFieldQuery

其他資源