你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Harvest Data - List By Party Id

参考

服务:: Azure Data Manager for Agriculture

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

返回特定服务器场下收获数据资源的分页列表。

GET /parties/{partyId}/harvest-data?api-version=2023-06-01-preview

具有可选参数:

GET /parties/{partyId}/harvest-data?minTotalYield={minTotalYield}&maxTotalYield={maxTotalYield}&minAvgYield={minAvgYield}&maxAvgYield={maxAvgYield}&minTotalWetMass={minTotalWetMass}&maxTotalWetMass={maxTotalWetMass}&minAvgWetMass={minAvgWetMass}&maxAvgWetMass={maxAvgWetMass}&minAvgMoisture={minAvgMoisture}&maxAvgMoisture={maxAvgMoisture}&minAvgSpeed={minAvgSpeed}&maxAvgSpeed={maxAvgSpeed}&sources={sources}&associatedBoundaryIds={associatedBoundaryIds}&minOperationStartDateTime={minOperationStartDateTime}&maxOperationStartDateTime={maxOperationStartDateTime}&minOperationEndDateTime={minOperationEndDateTime}&maxOperationEndDateTime={maxOperationEndDateTime}&minOperationModifiedDateTime={minOperationModifiedDateTime}&maxOperationModifiedDateTime={maxOperationModifiedDateTime}&minArea={minArea}&maxArea={maxArea}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

URI 参数

名称	在	必需	类型	说明
partyId	path	True	string	关联方的 ID。
api-version	query	True	string	请求的 API 版本
associatedBoundaryIds	query		string[]	与操作数据关联的边界 ID。
ids	query		string[]	资源的 ID。
maxArea	query		number double	应用操作的最大区域 (非独占) 。
maxAvgMoisture	query		number double	包含) (最大 AvgMoisture 值。
maxAvgSpeed	query		number double	(非独占) 的最大 AvgSpeed 值。
maxAvgWetMass	query		number double	最大 AvgWetMass 值 (非独占) 。
maxAvgYield	query		number double	非独占) (最大 AvgYield 值。
maxCreatedDateTime	query		string date-time	资源的最大创建日期 (非独占) 。
maxLastModifiedDateTime	query		string date-time	资源 (（含) ）的最大上次修改日期。
maxOperationEndDateTime	query		string date-time	操作数据的最大结束日期-时间，示例格式：yyyy-MM-ddTHH：mm：ssZ (包含) 。
maxOperationModifiedDateTime	query		string date-time	操作数据的最大修改日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ (非独占) 。
maxOperationStartDateTime	query		string date-time	操作数据的最大开始日期-时间，示例格式：yyyy-MM-ddTHH：mm：ssZ (含) 。
maxPageSize	query		integer int32	(非独占) 所需的最大项数。最小值 = 10，最大值 = 1000，默认值 = 50。
maxTotalWetMass	query		number double	(非独占) 的最大 WetMass 总值。
maxTotalYield	query		number double	包含) (最大收益率值。
minArea	query		number double	应用操作的最小区域 (非独占) 。
minAvgMoisture	query		number double	包含) (最小 AvgMoisture 值。
minAvgSpeed	query		number double	最低 AvgSpeed 值 (非独占) 。
minAvgWetMass	query		number double	最低 AvgWetMass 值 (非独占) 。
minAvgYield	query		number double	包含) (最小 AvgYield 值。
minCreatedDateTime	query		string date-time	资源 (非独占) 的最小创建日期。
minLastModifiedDateTime	query		string date-time	资源 (（含) ）的最小上次修改日期。
minOperationEndDateTime	query		string date-time	操作数据的最小结束日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ (含) 。
minOperationModifiedDateTime	query		string date-time	操作数据的最小修改日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ (含) 。
minOperationStartDateTime	query		string date-time	操作数据的最小开始日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ (含) 。
minTotalWetMass	query		number double	最小 WetMass 总值 (含) 。
minTotalYield	query		number double	最小收益率值 (非独占) 。
names	query		string[]	资源的名称。
propertyFilters	query		string[]	对 Properties 对象中的键值对进行筛选。例如 “{testKey} eq {testValue}”。
skipToken	query		string	跳过用于获取下一组结果的令牌。
sources	query		string[]	操作数据的源。
statuses	query		string[]	资源的状态。

请求头

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

响应

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

名称

类型

说明

200 OK

HarvestDataListResponse

Success

Other Status Codes

ErrorResponse

错误

标头

x-ms-error-code: string

安全性

Authorization

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

类型: apiKey
在: header

示例

HarvestData_ListByPartyId

示例请求

HTTP

GET /parties/PARTY123/harvest-data?api-version=2023-06-01-preview

示例响应

状态代码:: 200

{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "HARVESTOP123",
      "source": "Manual",
      "name": "Harvest data for North Farm",
      "description": "some description",
      "status": "Active",
      "operationStartDateTime": "2021-02-25T16:57:04Z",
      "operationEndDateTime": "2021-02-27T10:13:06Z",
      "operationModifiedDateTime": "2021-02-28T10:12:12Z",
      "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY",
      "area": {
        "unit": "acre",
        "value": 50
      },
      "totalYield": {
        "unit": "kilos",
        "value": 1400
      },
      "avgYield": {
        "unit": "kilosperacre",
        "value": 28
      },
      "totalWetMass": {
        "unit": "kilos",
        "value": 500
      },
      "avgWetMass": {
        "unit": "kilosperacre",
        "value": 10
      },
      "avgMoisture": {
        "unit": "percent",
        "value": 14.61
      },
      "avgSpeed": {
        "unit": "kmsperhour",
        "value": 7.2
      },
      "harvestProductDetails": [
        {
          "productName": "VAR1",
          "area": {
            "unit": "acre",
            "value": 30
          },
          "totalYield": {
            "unit": "kilos",
            "value": 900
          },
          "avgYield": {
            "unit": "kilosperacre",
            "value": 30
          },
          "totalWetMass": {
            "unit": "kilos",
            "value": 300
          },
          "avgWetMass": {
            "unit": "kilosperacre",
            "value": 10
          },
          "avgMoisture": {
            "unit": "percent",
            "value": 16.4
          }
        }
      ],
      "properties": {
        "Region": "Europe",
        "CountyCode": 123
      },
      "attachmentsLink": "https://<resource-name>.farmbeats.azure.net/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData",
      "createdDateTime": "2022-05-11T07:00:10.2750191Z",
      "modifiedDateTime": "2022-05-11T07:00:10.2750191Z",
      "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
    }
  ],
  "skipToken": "string",
  "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/harvestData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%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 服务的错误响应。有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
HarvestData	收获数据资源的架构。
HarvestDataListResponse	分页响应包含请求的对象列表和用于获取下一组结果的 URL 链接。
HarvestProductDetail	收获期间使用的产品的架构。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
Measure	用于存储度量读数和单位的架构。

Error

Azure AgPlatform 服务出错。

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

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

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

HarvestData

收获数据资源的架构。

名称	类型	说明
area	Measure	用于存储度量读数和单位的架构。
associatedBoundaryId	string	应用了操作的字段的可选边界 ID。
attachmentsLink	string	附件的链接。
avgMoisture	Measure	用于存储度量读数和单位的架构。
avgSpeed	Measure	用于存储度量读数和单位的架构。
avgWetMass	Measure	用于存储度量读数和单位的架构。
avgYield	Measure	用于存储度量读数和单位的架构。
createdBy	string	由用户/租户 ID 创建。
createdDateTime	string	创建资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
description	string	资源的文本说明。
eTag	string	用于实现乐观并发的 ETag 值。
harvestProductDetails	HarvestProductDetail[]	收获产品详细信息。
id	string	唯一的资源 ID。
modifiedBy	string	由用户/租户 ID 修改。
modifiedDateTime	string	上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用于标识资源的名称。
operationEndDateTime	string	操作数据的结束日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ。
operationModifiedDateTime	string	修改的操作数据的日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ。注意：这将由源提供程序本身指定。
operationStartDateTime	string	操作数据的开始日期时间，示例格式：yyyy-MM-ddTHH：mm：ssZ。
partyId	string	属于操作数据的参与方 ID。
properties		属于资源的键值对的集合。每对的键不能超过 50 个字符，并且值不能大于 150 个字符。注意：最多可以为资源提供 25 个键值对，并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH：mm：ssZ) 值。
source	string	资源的源。
status	string	资源的状态。
totalWetMass	Measure	用于存储度量读数和单位的架构。
totalYield	Measure	用于存储度量读数和单位的架构。

HarvestDataListResponse

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

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

HarvestProductDetail

收获期间使用的产品的架构。

名称	类型	说明
area	Measure	用于存储度量读数和单位的架构。
avgMoisture	Measure	用于存储度量读数和单位的架构。
avgWetMass	Measure	用于存储度量读数和单位的架构。
avgYield	Measure	用于存储度量读数和单位的架构。
productName	string	产品的名称。
totalWetMass	Measure	用于存储度量读数和单位的架构。
totalYield	Measure	用于存储度量读数和单位的架构。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

名称	类型	说明
code	string	包含错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

Measure

用于存储度量读数和单位的架构。

名称	类型	说明
unit	string	数据单位。
value	number	数据值。

通过

Harvest Data - List By Party Id

URI 参数

请求头

响应

安全性

Authorization

示例

HarvestData_ListByPartyId

示例请求

示例响应

定义

Error

ErrorResponse

HarvestData

HarvestDataListResponse

HarvestProductDetail

InnerError

Measure

其他资源