您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Application Data - List

获取给定搜索条件的所有农民中的应用程序数据资源的分页列表。

注意:
  1. 此 API 执行针对给定搜索条件的数据库的串行搜索。 如果 farmer Id 可用,强烈建议使用 "List By Farmer Id" API,因为它是高性能的。
  2. 用户将获得分页响应,每个页面包含指向下一页的链接。 几页可能没有 项 (零个结果)。 用户应使用 "nextLink" 循环访问所有页面。 当 "nextLink" 为 null 时,搜索进入结束。
GET /application-data?api-version=2021-03-31-preview
GET /application-data?minAvgMaterial={minAvgMaterial}&maxAvgMaterial={maxAvgMaterial}&minTotalMaterial={minTotalMaterial}&maxTotalMaterial={maxTotalMaterial}&sources={sources}&associatedBoundaryIds={associatedBoundaryIds}&operationBoundaryIds={operationBoundaryIds}&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=2021-03-31-preview

URI 参数

Name In Required Type Description
api-version
query True
  • string

请求的 API 版本。

$maxPageSize
query
  • integer
int32

要在单个页面中返回的最大项数。

$skipToken
query
  • string

跳过标记以获取下一组结果。

associatedBoundaryIds
query
  • array

完成应用程序操作的字段/季节性字段的边界 Id 列表。

ids
query
  • array

要返回的应用程序操作的 Id 列表。

maxArea
query
  • number
double

将返回对小于或等于给定值的区域执行的应用程序操作。

maxAvgMaterial
query
  • number
double

将返回平均材料小于或等于指定值的应用程序数据。

maxCreatedDateTime
query
  • string
date-time

(格式返回在给定 UTC 日期时间或之前创建的资源,格式为: Yyyy-mm-ddthh: MM: ssZ) 。

maxLastModifiedDateTime
query
  • string
date-time

(格式返回上次在给定 UTC 日期时间或之前修改的资源: Yyyy-mm-ddthh: MM: ssZ) 。

maxOperationEndDateTime
query
  • string
date-time

返回在给定 UTC 日期时间或之前结束的应用程序操作。

maxOperationModifiedDateTime
query
  • string
date-time

返回在源) (在给定 UTC 日期时间或之前修改的应用程序操作。

maxOperationStartDateTime
query
  • string
date-time

返回在给定 UTC 日期时间或之前开始的应用程序操作。

maxTotalMaterial
query
  • number
double

将返回总材料小于或等于指定值的应用程序数据。

minArea
query
  • number
double

返回对大于或等于给定值的区域执行的应用程序操作。

minAvgMaterial
query
  • number
double

将返回其平均材料大于或等于指定值的应用程序数据。

minCreatedDateTime
query
  • string
date-time

(格式返回在给定 UTC 日期时间或之后创建的资源,格式为: Yyyy-mm-ddthh: MM: ssZ) 。

minLastModifiedDateTime
query
  • string
date-time

(格式返回上次在给定 UTC 日期时间或之后修改的资源: Yyyy-mm-ddthh: MM: ssZ) 。

minOperationEndDateTime
query
  • string
date-time

返回在给定 UTC 日期时间或之后终止的应用程序操作。

minOperationModifiedDateTime
query
  • string
date-time

返回在源) (在给定 UTC 日期时间或之后修改的应用程序操作。

minOperationStartDateTime
query
  • string
date-time

返回在给定 UTC 日期时间或之后开始的应用程序操作。

minTotalMaterial
query
  • number
double

将返回总材料大于或等于指定值的应用程序数据。

names
query
  • array

要返回的应用程序操作的名称列表。

operationBoundaryIds
query
  • array

使用在其上执行应用程序操作的地理区域创建的边界 Id 列表。

propertyFilters
query
  • array

筛选 "属性" 中的键值对。 例如"{为 testkey} eq {testValue}"。

sources
query
  • array

将返回从给定的源列表中获取的应用程序数据。

statuses
query
  • array

返回仅具有给定状态的应用程序数据。

请求头

Name Required Type Description
Authorization True
  • string

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

响应

Name Type Description
200 OK

Success

Other Status Codes

错误

安全性

Authorization

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

Type: apiKey
In: header

示例

ApplicationData_List

Sample Request

GET /application-data?api-version=2021-03-31-preview

Sample Response

{
  "value": [
    {
      "applicationProductDetails": [
        {
          "productName": "Product123",
          "isCarrier": false,
          "avgMaterial": {
            "unit": "kilosperacre",
            "value": 0.15
          },
          "totalMaterial": {
            "unit": "kilos",
            "value": 9
          }
        }
      ],
      "avgMaterial": {
        "unit": "kilosperacre",
        "value": 0.15
      },
      "totalMaterial": {
        "unit": "kilos",
        "value": 9
      },
      "area": {
        "unit": "acre",
        "value": 60
      },
      "source": "Manual",
      "operationModifiedDateTime": "2021-02-25T16:57:04Z",
      "operationStartDateTime": "2021-02-27T10:13:06Z",
      "operationEndDateTime": "2021-02-28T11:12:12Z",
      "attachmentsLink": "https://test.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData",
      "associatedBoundaryId": "AssociatedBoundary123",
      "operationBoundaryId": "OperationBoundary123",
      "farmerId": "Farmer123",
      "id": "Application123",
      "eTag": "0300c56c-0000-0600-0000-60cc93920000",
      "status": "Active",
      "createdDateTime": "2021-06-18T12:37:38Z",
      "modifiedDateTime": "2021-06-18T12:37:38Z",
      "name": "Test application data",
      "description": "Test application data description",
      "properties": {
        "Region": "Central US",
        "RetailerId": 123
      }
    }
  ],
  "nextLink": "https://bb-prod-wcus-1.farmbeats.azure.net/application-data?api-version=2021-03-31-preview&$skipToken=ffa6d232-0892-4e7e-bc8d-6acb12645251"
}

定义

ApplicationData

应用程序数据资源的架构。

ApplicationDataListResponse

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

ApplicationProductDetail

在应用程序中使用的产品的架构。

Error

Azure FarmBeats 服务出错。

ErrorResponse

Azure AgPlatform 服务的错误响应。 ErrorResponse 参考文档。

InnerError

包含错误列表的内部错误。 InnerError 参考文档。

Measure

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

ApplicationData

应用程序数据资源的架构。

Name Type Description
applicationProductDetails

应用程序产品详细信息。

area

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

associatedBoundaryId
  • string

完成应用程序操作的字段/季节性字段的边界 Id。

attachmentsLink
  • string

指向可用于查找形状文件、光栅文件或与此操作关联的任何其他附件的 "附件 API" 的链接。

avgMaterial

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

createdDateTime
  • string

UTC 日期-创建资源的时间 (格式: yyyy-MM-Yyyy-mm-ddthh: MM: ssZ) 。

description
  • string

应用程序操作的简要说明。

eTag
  • string

ETag 值可用于实现开放式并发。

farmerId
  • string

关联的 farmer 的 Id。

id
  • string

操作 (应用程序) 的唯一 Id。此 Id 对于给定的 farmer 是唯一的。

modifiedDateTime
  • string

上次修改资源的 UTC 日期时间 (格式: yyyy-MM-Yyyy-mm-ddthh: MM: ssZ) 。

name
  • string

应用程序操作的名称。

operationBoundaryId
  • string

使用在其上执行应用程序操作的地理区域创建的边界的 Id。

operationEndDateTime
  • string

UTC 日期-操作结束的时间 (格式: yyyy-MM-Yyyy-mm-ddthh: MM: ssZ) 。

operationModifiedDateTime
  • string

UTC 日期-在源处修改操作数据的时间 (格式: yyyy-MM-Yyyy-mm-ddthh: MM: ssZ) 。这将由源指定。

operationStartDateTime
  • string

UTC 日期-操作开始时间 (格式: yyyy-MM-Yyyy-mm-ddthh: MM: ssZ) 。

properties
  • object

与资源关联的键值对的集合。键是字符串,值可以是数字或字符串。最多可以有25个键值对与一个资源关联。

source
  • string

表示从中获取应用程序数据的源。

status
  • string

用户确定资源的状态。

totalMaterial

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

ApplicationDataListResponse

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

Name Type Description
$skipToken
  • string

用于检索下一页的标记。 如果为 null,则没有其他页面。

nextLink
  • string

列表中下一页结果的继续链接(绝对 URI)。 如果为 null,则没有其他页面。

value

请求的对象的列表。

ApplicationProductDetail

在应用程序中使用的产品的架构。

Name Type Description
avgMaterial

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

isCarrier
  • boolean

指示产品是否为水箱混合的载波。

productName
  • string

应用的产品的名称。

totalMaterial

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

Error

Azure FarmBeats 服务出错。

Name Type Description
code
  • string

服务器定义的一组错误代码。

details

导致此报告错误的特定错误的详细信息的数组。

innererror

包含错误列表的内部错误。 InnerError 参考文档。

message
  • string

错误的用户可读表示形式。

target
  • string

错误的目标。

ErrorResponse

Azure AgPlatform 服务的错误响应。 ErrorResponse 参考文档。

Name Type Description
error

Azure FarmBeats 服务出错。

traceId
  • string

唯一跟踪 Id。

InnerError

包含错误列表的内部错误。 InnerError 参考文档。

Name Type Description
code
  • string

由包含错误提供的特定错误代码。

innererror

包含错误列表的内部错误。 InnerError 参考文档。

Measure

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

Name Type Description
unit
  • string

数据单元。

value
  • number

数据值。