Management Zones - List By Farmer Id

服务:

Azure Data Manager for Agriculture

API 版本:

2021-07-31-preview

返回特定农民下管理区域资源的分页列表。

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview

具有可选参数:

GET /farmers/{farmerId}/management-zones?types={types}&cropIds={cropIds}&seasonIds={seasonIds}&fieldIds={fieldIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview

URI 参数

名称	在	必需	类型	说明
farmerId	path	True	string	相关农民的 ID。
api-version	query	True	string	请求的 API 版本
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	所需的项数上限（含）。 最小值 = 10，最大值 = 1000，默认值 = 50。
$skipToken	query		string	跳过令牌以获取下一组结果。
cropIds	query		string[]	ManagementZone 的 CropId。
fieldIds	query		string[]	ManagementZone 的 FieldIds。
ids	query		string[]	资源的 ID。
maxCreatedDateTime	query		string (date-time)	资源的最大创建日期（含）。
maxLastModifiedDateTime	query		string (date-time)	资源（含）上次修改日期上限。
minCreatedDateTime	query		string (date-time)	资源（含）的最小创建日期。
minLastModifiedDateTime	query		string (date-time)	资源（含）的上次修改日期（含）。
names	query		string[]	资源的名称。
propertyFilters	query		string[]	筛选 Properties 对象中的键值对。 例如 “{testKey} eq {testValue}”。
seasonIds	query		string[]	ManagementZone 的 SeasonIds。
sources	query		string[]	ManagementZone 的来源。
statuses	query		string[]	资源的状态。
types	query		string[]	ManagementZone 的类型。

请求头

名称	必需	类型	说明
Authorization	True	string	请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试了未经身份验证的调用，可能需要清除浏览器缓存。

响应

名称	类型	说明
200 OK	ManagementZoneListResponse	成功
Other Status Codes	ErrorResponse	错误 标头 x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试了未经身份验证的调用，可能需要清除浏览器缓存。

类型: apiKey
在: header

示例

ManagementZones_ListByFarmerId

示例请求

HTTP

GET /farmers/FARMER123/management-zones?api-version=2021-07-31-preview

示例响应

状态代码:

200

{
  "value": [
    {
      "farmerId": "FARMER123",
      "id": "ManagementZone123",
      "type": "Nutrient rich",
      "seasonId": "Season123",
      "cropId": "Crop123",
      "fieldId": "Field123",
      "source": "Agronomist",
      "name": "John Smith's ManagementZone",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes"
      },
      "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/{{farmerId}}/management-zones?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"
}

定义

名称	说明
Error	Azure AgPlatform 服务中的错误。
ErrorResponse	Azure AgPlatform 服务的错误响应。 <参见 href=“https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">ErrorResponse 参考文档。</see> 中。
InnerError	包含错误列表的内部错误。 <参见 href=“https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError 参考文档</参见>。
ManagementZone	ManagementZone 对象的 Api 模型。
ManagementZoneListResponse	分页响应包含请求的对象列表和 URL 链接，用于获取下一组结果。

Error

Object

Azure AgPlatform 服务中的错误。

名称	类型	说明
code	string	服务器定义的错误代码集。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerError	包含错误列表的内部错误。 <参见 href=“https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError 参考文档</参见>。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorResponse

Object

Azure AgPlatform 服务的错误响应。 <参见 href=“https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">ErrorResponse 参考文档。</see> 中。

名称	类型	说明
error	Error	Azure AgPlatform 服务中的错误。
traceId	string	唯一跟踪 ID。

InnerError

Object

包含错误列表的内部错误。 <参见 href=“https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError 参考文档</参见>。

名称	类型	说明
code	string	包含的错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。 <参见 href=“https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError 参考文档</参见>。

ManagementZone

Object

ManagementZone 对象的 Api 模型。

名称	类型	说明
createdDateTime	string (date-time)	创建资源的日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ。
cropId	string	与 ManagementZone 关联的裁剪 ID。
description	string minLength: 0 maxLength: 500	资源的文本说明。
eTag	string	实现乐观并发的 ETag 值。
farmerId	string	与 ManagementZone 关联的农民 ID。
fieldId	string	与 ManagementZone 关联的字段 ID。
id	string	唯一的资源 ID。
modifiedDateTime	string (date-time)	上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ。
name	string minLength: 0 maxLength: 100	用于标识资源的名称。
properties		属于资源的键值对的集合。 每对不能具有大于 50 个字符的键，并且不能具有大于 150 个字符的值。 注意：最多可以为资源提供 25 个键值对，仅支持字符串、数字和日期/时间（yyyy-MM-ddTHH：mm：ssZ） 值。
seasonId	string	与 ManagementZone 关联的季节 ID。
source	string minLength: 2 maxLength: 100	资源的源。
status	string minLength: 0 maxLength: 100	资源的状态。
type	string minLength: 0 maxLength: 100	ManagementZone 的类型。

ManagementZoneListResponse

Object

分页响应包含请求的对象列表和 URL 链接，用于获取下一组结果。

名称	类型	说明
$skipToken	string	用于检索下一页的令牌。 如果为 null，则没有其他页面。
nextLink	string	指向列表中的下一页结果的延续链接（绝对 URI）。
value	ManagementZone[]	请求的对象列表。