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

Boundaries - Get

获取特定 farmer 下的指定边界资源。

GET {Endpoint}/farmers/{farmerId}/boundaries/{boundaryId}?api-version=2021-03-31-preview

URI 参数

Name In Required Type Description
boundaryId
path True
  • string

边界的 ID。

Endpoint
path True
  • string

FarmBeats 资源的终结点 (协议和主机名,例如: https://{}. FarmBeats) 。

farmerId
path True
  • string

关联的 farmer 的 ID。

api-version
query True
  • string

请求的 API 版本

请求头

Name Required Type Description
Authorization True
  • string

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

响应

Name Type Description
200 OK

Success

Other Status Codes

错误

安全性

Authorization

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

Type: apiKey
In: header

示例

Boundaries_Get

Sample Request

GET {Endpoint}/farmers/FARMER123/boundaries/BOUNDARY123?api-version=2021-03-31-preview

Sample Response

{
  "parentId": "FIELD123",
  "isPrimary": false,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.704571723937988,
          20.545385304358106
        ],
        [
          73.704571723937988,
          20.545385304358106
        ],
        [
          73.704485893249512,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.710236549377441,
          20.545083911372505
        ],
        [
          73.706631660461426,
          20.546992723579137
        ],
        [
          73.704571723937988,
          20.545385304358106
        ]
      ]
    ]
  },
  "name": "John Smith's Boundary",
  "description": "Some description"
}

定义

Boundary

边界资源的架构。

Error

Azure AgPlatform 服务中的错误。

ErrorResponse

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

GeoJsonObjectType

GeoJSON 对象类型。

InnerError

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

MultiPolygon

MultiPolygon 几何。

Point

点几何。

Polygon

多边形几何。

Boundary

边界资源的架构。

Name Type Description
acreage
  • number

以英亩为单位的边界区域。

createdDateTime
  • string

创建资源时的日期时间,示例格式: yyyy-MM-Yyyy-mm-ddthh: MM: ssZ。

description
  • string

资源的文本说明。

eTag
  • string

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

farmerId
  • string

Farmer ID。

geometry GeoJsonObject:

GeoJSON 抽象类。

id
  • string

唯一的资源 ID。

isPrimary
  • boolean

是边界主。

modifiedDateTime
  • string

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

name
  • string

用于标识资源的名称。

parentId
  • string

其所属) 父级 (字段或 seasonalField 的 ID。

parentType
  • string

它所属的父项的类型。

properties
  • object

属于资源的键值对的集合。 每个对的键不得超过50个字符,并且不能有大于150个字符的值。 注意:可以为一个资源提供最多25个键值对,并且仅支持 string 和数字值。

status
  • string

资源的状态。

Error

Azure AgPlatform 服务中的错误。

Name Type Description
code
  • string

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

details

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

innererror

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

message
  • string

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

target
  • string

错误的目标。

ErrorResponse

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

Name Type Description
error

Azure AgPlatform 服务中的错误。

traceId
  • string

唯一跟踪 ID。

GeoJsonObjectType

GeoJSON 对象类型。

Name Type Description
MultiPolygon
  • string
Point
  • string
Polygon
  • string

InnerError

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

Name Type Description
code
  • string

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

innererror

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

MultiPolygon

MultiPolygon 几何。

Name Type Description
coordinates
  • array[]

获取或设置 GeoJSON 对象的坐标。 它必须是多边形的数组,每个多边形都包含线性环的列表。 对于包含多个环的多边形,第一个必须是外环,其他任何环必须是内部环。

type string:

GeoJSON 对象类型。

Point

点几何。

Name Type Description
coordinates
  • number[]

获取或设置此点的坐标。 它必须为2D 或3D 系统的2或3个元素的数组。

type string:

GeoJSON 对象类型。

Polygon

多边形几何。

Name Type Description
coordinates
  • array[]

获取或设置 GeoJSON 对象的类型。 它必须是线性环坐标阵列的数组。 对于包含多个环的多边形,第一个必须是外环,其他任何环必须是内部环。

type string:

GeoJSON 对象类型。