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

Seasonal Fields - Search

参考

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

通过相交几何图形在所有方中搜索 SeasonalFields。

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

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
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	跳过令牌以获取下一组结果。

请求头

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

请求正文

名称	类型	说明
cropIds	string[]	资源的 CropIds。
cropProductIds	string[]	资源的 CropProductIds。
farmIds	string[]	资源的 FarmIds。
fieldIds	string[]	资源的 FieldIds。
ids	string[]	资源的 ID。
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (有关详细信息： https://geojson.org/) 。注意：坐标应采用[经度、纬度]格式。
maxCreatedDateTime	string	资源的最大创建日期 (非独占) 。
maxLastModifiedDateTime	string	资源 (（含) ）的最大上次修改日期。
minCreatedDateTime	string	资源 (非独占) 的最小创建日期。
minLastModifiedDateTime	string	资源 (（含) ）的最小上次修改日期。
names	string[]	资源的名称。
partyId	string	属于操作数据的参与方 ID。
propertyFilters	string[]	对 Properties 对象中的键值对进行筛选。例如“{testKey} eq {testValue}”。
seasonIds	string[]	资源的 SeasonIds。
statuses	string[]	资源的状态。

响应

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

名称

类型

说明

200 OK

SeasonalFieldMetaDataListResponse

Success

Other Status Codes

ErrorResponse

错误

Headers

x-ms-error-code: string

安全性

Authorization

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

Type: apiKey
In: header

示例

SeasonalFields_Search

Sample Request

HTTP

POST {endpoint}/seasonal-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
        ]
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "SEASONALFIELD123",
      "partyId": "FARMER123",
      "farmId": "FARM123",
      "fieldId": "FIELD123",
      "seasonId": "WINTER_WHEAT_2021",
      "cropId": "WHEAT",
      "name": "John Smith's Seasonal 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"
}

定义

名称	说明
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。有关 ErrorResponse 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
GeoJsonObjectType	GeoJSON 对象类型。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
MultiPolygon	MultiPolygon 几何图形。
Point	点几何图形。
Polygon	多边形几何图形。
SearchSeasonalFieldQuery	SearchAllBoundaries 和 SearchBoundaries 参数。
SeasonalFieldMetaData	季节性字段资源的架构。
SeasonalFieldMetaDataListResponse	分页响应包含请求的对象列表和用于获取下一组结果的 skipToken。

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。

GeoJsonObjectType

GeoJSON 对象类型。

名称	类型	说明
MultiPolygon	string
Point	string
Polygon	string

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 。

MultiPolygon

MultiPolygon 几何图形。

名称	类型	说明
coordinates	number[]	获取或设置 GeoJSON 对象的坐标。它必须是多边形数组，每个多边形都包含线性环的列表。对于具有多个这些环的多边形，第一个必须是外环，任何其他必须是内部环。
type	string: MultiPolygon	GeoJSON 对象类型。

Point

点几何图形。

名称	类型	说明
coordinates	number[]	获取或设置此点的坐标。它必须是 2D 或 3D 系统的 2 或 3 个元素的数组。
type	string: Point	GeoJSON 对象类型。

Polygon

多边形几何图形。

名称	类型	说明
coordinates	number[]	获取或设置 GeoJSON 对象的类型。它必须是线性环坐标数组的数组。对于具有多个这些环的多边形，第一个必须是外环，任何其他必须是内部环。
type	string: Polygon	GeoJSON 对象类型。

SearchSeasonalFieldQuery

SearchAllBoundaries 和 SearchBoundaries 参数。

名称	类型	说明
cropIds	string[]	资源的 CropIds。
cropProductIds	string[]	资源的 CropProductIds。
farmIds	string[]	资源的 FarmIds。
fieldIds	string[]	资源的 FieldIds。
ids	string[]	资源的 ID。
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (有关详细信息： https://geojson.org/) 。注意：坐标应采用[经度、纬度]格式。
maxCreatedDateTime	string	资源的最大创建日期 (非独占) 。
maxLastModifiedDateTime	string	资源 (（含) ）的最大上次修改日期。
minCreatedDateTime	string	资源 (非独占) 的最小创建日期。
minLastModifiedDateTime	string	资源 (（含) ）的最小上次修改日期。
names	string[]	资源的名称。
partyId	string	属于操作数据的参与方 ID。
propertyFilters	string[]	对 Properties 对象中的键值对进行筛选。例如“{testKey} eq {testValue}”。
seasonIds	string[]	资源的 SeasonIds。
statuses	string[]	资源的状态。

SeasonalFieldMetaData

季节性字段资源的架构。

名称	类型	说明
createdBy	string	由用户/租户 ID 创建。
createdDateTime	string	创建资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
cropId	string	它所属的裁剪的 ID。
cropProductIds	string[]	CropProduct ID。
description	string	资源的文本说明。
eTag	string	用于实现乐观并发的 ETag 值。
farmId	string	关联服务器场的 ID。
fieldId	string	关联字段的 ID。
id	string	唯一的资源 ID。
modifiedBy	string	由用户/租户 ID 修改。
modifiedDateTime	string	上次修改资源的日期时间，示例格式：yyyy-MM-ddTHH:mm:ssZ。
name	string	用于标识资源的名称。
partyId	string	群 ID。
properties		属于资源的键值对的集合。每对的键不能超过 50 个字符，并且值不能大于 150 个字符。注意：最多可以为资源提供 25 个键值对，并且仅支持字符串、数字和日期时间 (yyyy-MM-ddTHH：mm：ssZ) 值。
seasonId	string	它所属的季节的 ID。
source	string	资源的源。
status	string	资源的状态。

SeasonalFieldMetaDataListResponse

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

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

通过

Seasonal Fields - Search

URI 参数

请求头

请求正文

响应

安全性

Authorization

示例

SeasonalFields_Search

Sample Request

Sample Response

定义

Error

ErrorResponse

GeoJsonObjectType

InnerError

MultiPolygon

Point

Polygon

SearchSeasonalFieldQuery

SeasonalFieldMetaData

SeasonalFieldMetaDataListResponse

其他资源