Farms - List By Party Id

參考

服務:: Azure Data Manager for Agriculture

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

傳回特定合作物件下伺服器數位資源的編頁清單。

GET {endpoint}/parties/{partyId}/farms?api-version=2023-11-01-preview

含選擇性參數:

GET {endpoint}/parties/{partyId}/farms?ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	命名空間的主機名，例如 admaInstanceName.farmbeats.azure.net
partyId	path	True	string	相關聯對象的標識碼。
api-version	query	True	string	要求的 API 版本
ids	query		string[]	資源的標識碼。
maxCreatedDateTime	query		string date-time	資源 (內含) 的建立日期上限。
maxLastModifiedDateTime	query		string date-time	資源 (內含) 的上次修改日期上限。
maxPageSize	query		integer int32	包含) (所需的項目數目上限。最小值 = 10，最大值 = 1000，預設值 = 50。
minCreatedDateTime	query		string date-time	資源 (內含) 的最低建立日期。
minLastModifiedDateTime	query		string date-time	資源 (內含) 的上次修改日期下限。
names	query		string[]	資源的名稱。
propertyFilters	query		string[]	篩選 Properties 物件內的索引鍵/值組。例如 “{testKey} eq {testValue}”。
skipToken	query		string	略過令牌以取得下一組結果。
statuses	query		string[]	資源的狀態。

要求標頭

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

回應

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

名稱

類型

Description

200 OK

FarmListResponse

成功

Other Status Codes

ErrorResponse

[錯誤]

標題

x-ms-error-code: string

安全性

Authorization

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

類型: apiKey
位於: header

範例

Farms_ListByPartyId

範例要求

HTTP

GET {endpoint}/parties/PARTY123/farms?api-version=2023-11-01-preview

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "FARM123",
      "partyId": "PARTY123",
      "name": "John Smith's Farm",
      "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"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/farms/{{farmId}}?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 參考檔。
Farm	伺服器數位資源的架構。
FarmListResponse	分頁回應包含要求的物件清單和 URL 連結，以取得下一組結果。
InnerError	包含錯誤清單的內部錯誤。請參閱 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object InnerError 參考檔。

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

Farm

伺服器數位資源的架構。

名稱	類型	Description
createdBy	string	由使用者/租使用者標識碼建立。
createdDateTime	string	建立資源的日期時間，範例格式：yyyy-MM-ddTHH:mm:ssZ。
description	string	資源的文字描述。
eTag	string	要實作開放式並行存取的ETag值。
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	資源的狀態。

FarmListResponse

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

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

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

共用方式為

Farms - List By Party Id

URI 參數

要求標頭

回應

安全性

Authorization

範例

Farms_ListByPartyId

範例要求

範例回覆

定義

Error

ErrorResponse

Farm

FarmListResponse

InnerError

其他資源