你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Planting Data - Search
通过交叉几何图形在所有各方中搜索 PlantingData。
POST {endpoint}/planting-data:search?api-version=2023-11-01-preview
POST {endpoint}/planting-data: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 版本 |
max
|
query |
integer int32 |
(非独占) 所需的项目数上限。 最小值 = 10,最大值 = 1000,默认值 = 50。 |
|
skip
|
query |
string |
跳过用于获取下一组结果的令牌。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
associatedResourceIds |
string[] |
资源的资源 ID。 |
associatedResourceType |
string |
资源类型。 即 Farmer、Farm、Field、SeasonalField、ApplicationData、HarvestData、TillageData、PlantingData、PlantTissueAnalysis。 |
ids |
string[] |
资源的 ID。 |
intersectsWithGeometry | GeoJsonObject: |
GeoJSON (有关详细信息: https://geojson.org/) 。 注意:坐标应采用 [经度, 纬度] 格式。 |
maxArea |
number |
边界的最大面积 (包括) 。 |
maxAvgMaterial |
number |
最大 AvgMaterial 值 (非独占) 。 |
maxAvgPlantingRate |
number |
最大 AvgPlantingRate 值 (非独占) 。 |
maxCreatedDateTime |
string |
资源的最大创建日期 (非独占) 。 |
maxLastModifiedDateTime |
string |
资源的上次修改日期上限 (非独占) 。 |
maxOperationEndDateTime |
string |
操作数据的最大结束日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
maxOperationModifiedDateTime |
string |
操作数据的最大修改日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ (含) 。 |
maxOperationStartDateTime |
string |
操作数据的最大开始日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
maxTotalMaterial |
number |
最大 TotalMaterial 值 (非独占) 。 |
minArea |
number |
边界的最小面积 (非独占) 。 |
minAvgMaterial |
number |
AvgMaterial 的最小值 (非独占) 。 |
minAvgPlantingRate |
number |
AvgPlantingRate 最小值 (非独占) 。 |
minCreatedDateTime |
string |
资源的最小创建日期 (非独占) 。 |
minLastModifiedDateTime |
string |
资源的上次修改日期的最小 ((含) )。 |
minOperationEndDateTime |
string |
操作数据的最小结束日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
minOperationModifiedDateTime |
string |
操作数据的最小修改日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
minOperationStartDateTime |
string |
操作数据的最小开始日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ (含) 。 |
minTotalMaterial |
number |
最小 TotalMaterial 值 (非独占) 。 |
names |
string[] |
资源的名称。 |
partyId |
string |
属于操作数据的参与方 ID。 |
propertyFilters |
string[] |
筛选 Properties 对象中的键值对。 例如“{testKey} eq {testValue}”。 |
sources |
string[] |
操作数据的源。 |
statuses |
string[] |
资源的状态。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
错误 Headers x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
Type:
apiKey
In:
header
示例
PlantingData_Search
Sample Request
POST {endpoint}/planting-data: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
{
"value": [
{
"partyId": "FARMER123",
"id": "PLANTINGOP123",
"source": "Manual",
"name": "Planting 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:14:12Z",
"associatedResource": {
"type": "Field",
"id": "FieldId"
},
"avgPlantingRate": {
"unit": "seedsperacre",
"value": 30
},
"area": {
"unit": "acre",
"value": 30
},
"totalMaterial": {
"unit": "seeds",
"value": 758814
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 25293
},
"plantingProductDetails": [
{
"productName": "VAR1",
"area": {
"unit": "acre",
"value": 20
},
"totalMaterial": {
"unit": "seeds",
"value": 389214
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 19460
}
}
],
"properties": {
"Region": "Europe",
"CountyCode": 123
},
"createdDateTime": "2021-02-27T04:57:04Z",
"modifiedDateTime": "2021-03-08T18:22:07Z",
"eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
}
],
"skipToken": "string",
"nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/plantingData?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 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。 |
Farm |
资源类型。 |
Geo |
GeoJSON 对象类型。 |
Geo |
用于存储资源类型和资源 ID 的架构。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Measure |
用于存储度量读数和单位的架构。 |
Multi |
MultiPolygon 几何图形。 |
Planting |
种植数据资源的架构。 |
Planting |
分页响应包含请求的对象列表和 skipToken,用于获取下一组结果。 |
Planting |
种植产品详细信息的架构。 |
Point |
点几何图形。 |
Polygon |
多边形几何图形。 |
Search |
SearchPlantingDataQuery。 |
Error
Azure AgPlatform 服务出错。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集。 |
details |
Error[] |
有关导致此报告错误的特定错误的详细信息数组。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
|
message |
string |
错误的用户可读表示形式。 |
target |
string |
错误的目标。 |
ErrorResponse
来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。
名称 | 类型 | 说明 |
---|---|---|
error |
Azure AgPlatform 服务出错。 |
|
traceId |
string |
唯一跟踪 ID。 |
FarmHierarchyGeoResourceType
资源类型。
名称 | 类型 | 说明 |
---|---|---|
ApplicationData |
string |
|
Field |
string |
|
HarvestData |
string |
|
PlantTissueAnalysis |
string |
|
PlantingData |
string |
|
Prescription |
string |
|
SeasonalField |
string |
|
TillageData |
string |
|
Zone |
string |
GeoJsonObjectType
GeoJSON 对象类型。
名称 | 类型 | 说明 |
---|---|---|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
GeoResource
用于存储资源类型和资源 ID 的架构。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
type |
资源类型。 |
InnerError
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含的错误提供的特定错误代码。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Measure
用于存储度量读数和单位的架构。
名称 | 类型 | 说明 |
---|---|---|
unit |
string |
数据单位。 |
value |
number |
数据值。 |
MultiPolygon
MultiPolygon 几何图形。
名称 | 类型 | 说明 |
---|---|---|
coordinates |
number[] |
获取或设置 GeoJSON 对象的坐标。 它必须是多边形数组,每个多边形都包含线性环的列表。 对于具有多个这些环的多边形,第一个必须是外环,任何其他环必须是内部环。 |
type | string: |
GeoJSON 对象类型。 |
PlantingDataMetaData
种植数据资源的架构。
名称 | 类型 | 说明 |
---|---|---|
area |
用于存储度量读数和单位的架构。 |
|
associatedResource |
用于存储资源类型和资源 ID 的架构。 |
|
avgMaterial |
用于存储度量读数和单位的架构。 |
|
avgPlantingRate |
用于存储度量读数和单位的架构。 |
|
createdBy |
string |
由用户/租户 ID 创建。 |
createdDateTime |
string |
创建资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
description |
string |
资源的文本说明。 |
eTag |
string |
实现乐观并发的 ETag 值。 |
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。 |
plantingProductDetails |
种植产品详细信息。 |
|
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。 |
|
source |
string |
资源的源。 |
status |
string |
资源的状态。 |
totalMaterial |
用于存储度量读数和单位的架构。 |
PlantingDataMetaDataListResponse
分页响应包含请求的对象列表和 skipToken,用于获取下一组结果。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
列表中下一页结果的继续链接(绝对 URI)。 |
skipToken |
string |
用于检索下一页的令牌。 如果为 null,则没有其他页。 |
value |
请求的对象列表。 |
PlantingProductDetail
种植产品详细信息的架构。
名称 | 类型 | 说明 |
---|---|---|
area |
用于存储度量读数和单位的架构。 |
|
avgMaterial |
用于存储度量读数和单位的架构。 |
|
productName |
string |
产品的名称。 |
totalMaterial |
用于存储度量读数和单位的架构。 |
Point
点几何图形。
名称 | 类型 | 说明 |
---|---|---|
coordinates |
number[] |
获取或设置此点的坐标。 对于 2D 或 3D 系统,它必须是包含 2 或 3 个元素的数组。 |
type | string: |
GeoJSON 对象类型。 |
Polygon
多边形几何图形。
名称 | 类型 | 说明 |
---|---|---|
coordinates |
number[] |
获取或设置 GeoJSON 对象的类型。 它必须是线性环坐标数组的数组。 对于具有多个这些环的多边形,第一个必须是外环,任何其他环必须是内部环。 |
type | string: |
GeoJSON 对象类型。 |
SearchPlantingDataQuery
SearchPlantingDataQuery。
名称 | 类型 | 说明 |
---|---|---|
associatedResourceIds |
string[] |
资源的资源 ID。 |
associatedResourceType |
string |
资源类型。 即 Farmer、Farm、Field、SeasonalField、ApplicationData、HarvestData、TillageData、PlantingData、PlantTissueAnalysis。 |
ids |
string[] |
资源的 ID。 |
intersectsWithGeometry | GeoJsonObject: |
GeoJSON (有关详细信息: https://geojson.org/) 。 注意:坐标应采用 [经度, 纬度] 格式。 |
maxArea |
number |
边界的最大面积 (包括) 。 |
maxAvgMaterial |
number |
最大 AvgMaterial 值 (非独占) 。 |
maxAvgPlantingRate |
number |
最大 AvgPlantingRate 值 (非独占) 。 |
maxCreatedDateTime |
string |
资源的最大创建日期 (非独占) 。 |
maxLastModifiedDateTime |
string |
资源的上次修改日期上限 (非独占) 。 |
maxOperationEndDateTime |
string |
操作数据的最大结束日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
maxOperationModifiedDateTime |
string |
操作数据的最大修改日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ (含) 。 |
maxOperationStartDateTime |
string |
操作数据的最大开始日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
maxTotalMaterial |
number |
最大 TotalMaterial 值 (非独占) 。 |
minArea |
number |
边界的最小面积 (非独占) 。 |
minAvgMaterial |
number |
AvgMaterial 的最小值 (非独占) 。 |
minAvgPlantingRate |
number |
AvgPlantingRate 最小值 (非独占) 。 |
minCreatedDateTime |
string |
资源的最小创建日期 (非独占) 。 |
minLastModifiedDateTime |
string |
资源的上次修改日期的最小 ((含) )。 |
minOperationEndDateTime |
string |
操作数据的最小结束日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
minOperationModifiedDateTime |
string |
操作数据的最小修改日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ ((含) )。 |
minOperationStartDateTime |
string |
操作数据的最小开始日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ (含) 。 |
minTotalMaterial |
number |
最小 TotalMaterial 值 (非独占) 。 |
names |
string[] |
资源的名称。 |
partyId |
string |
属于操作数据的参与方 ID。 |
propertyFilters |
string[] |
筛选 Properties 对象中的键值对。 例如“{testKey} eq {testValue}”。 |
sources |
string[] |
操作数据的源。 |
statuses |
string[] |
资源的状态。 |