你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Prescriptions - Get
获取特定参与方下的指定处方资源。
GET {endpoint}/parties/{partyId}/prescriptions/{prescriptionId}?api-version=2023-11-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
命名空间的主机名,例如 admaInstanceName.farmbeats.azure.net |
party
|
path | True |
string |
关联方 ID。 |
prescription
|
path | True |
string |
处方 ID。 |
api-version
|
query | True |
string |
请求的 API 版本 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
错误 标头 x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
类型:
apiKey
在:
header
示例
Prescriptions_Get
示例请求
GET {endpoint}/parties/PARTY123/prescriptions/PRESCRIPTION123?api-version=2023-11-01-preview
示例响应
{
"id": "PRESCRIPTION123",
"partyId": "PARTY123",
"prescriptionMapId": "PRESCRIPTINMAP123",
"productCode": "PRODUCTCODE123",
"productName": "Some name",
"type": "Planting",
"measurements": {
"total material": {
"value": 12,
"unit": "pounds"
},
"rate": {
"value": 13,
"unit": "Km/hr"
}
},
"name": "John Smith's Prescription",
"status": "Active",
"description": "Some description",
"source": "source",
"properties": {
"Irrigated": "Yes",
"RetailerId": "Retailer123"
},
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"createdBy": "00000000-0000-0000-0000-000000000000",
"modifiedBy": "00000000-0000-0000-0000-000000000000",
"eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
定义
名称 | 说明 |
---|---|
Error |
Azure AgPlatform 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。 |
Geo |
GeoJSON 对象类型。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Measure |
用于存储度量读数和单位的架构。 |
Multi |
MultiPolygon 几何图形。 |
Point |
点几何图形。 |
Polygon |
多边形几何图形。 |
Prescription |
Api Model for Prescription 对象。 |
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。 |
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 参考文档,请参阅 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 对象类型。 |
Point
点几何图形。
名称 | 类型 | 说明 |
---|---|---|
coordinates |
number[] |
获取或设置此点的坐标。 对于 2D 或 3D 系统,它必须是包含 2 或 3 个元素的数组。 |
type | string: |
GeoJSON 对象类型。 |
Polygon
多边形几何图形。
名称 | 类型 | 说明 |
---|---|---|
coordinates |
number[] |
获取或设置 GeoJSON 对象的类型。 它必须是线性环坐标数组的数组。 对于具有多个这些环的多边形,第一个必须是外环,任何其他环必须是内部环。 |
type | string: |
GeoJSON 对象类型。 |
Prescription
Api Model for Prescription 对象。
名称 | 类型 | 说明 |
---|---|---|
createdBy |
string |
由用户/租户 ID 创建。 |
createdDateTime |
string |
创建资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
description |
string |
资源的文本说明。 |
eTag |
string |
实现乐观并发的 ETag 值。 |
geometry | GeoJsonObject: |
GeoJSON (有关详细信息: https://geojson.org/) 。 注意:坐标应采用 [经度, 纬度] 格式。 |
id |
string |
唯一资源 ID。 |
measurements |
<string, Measure> |
措施。 |
modifiedBy |
string |
由用户/租户 ID 修改。 |
modifiedDateTime |
string |
上次修改资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
name |
string |
用于标识资源的名称。 |
partyId |
string |
群 ID。 |
prescriptionMapId |
string |
处方映射 ID。 |
productCode |
string |
产品代码。 |
productName |
string |
产品名称。 |
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。 |
|
source |
string |
资源的源。 |
status |
string |
资源的状态。 |
type |
string |
处方类型。 |