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

Insights - Get

获取特定参与方下的指定见解资源。

GET {endpoint}/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}?api-version=2023-11-01-preview

URI 参数

名称 必需 类型 说明
endpoint
path True

string

uri

命名空间的主机名,例如 admaInstanceName.farmbeats.azure.net

insightId
path True

string

见解资源的 ID。

modelId
path True

string

关联模型的 ID。

partyId
path True

string

关联方 ID。

resourceId
path True

string

关联资源的 ID。

resourceType
path True

string

与记录关联的资源类型。

api-version
query True

string

请求的 API 版本

请求头

名称 必需 类型 说明
Authorization True

string

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

响应

名称 类型 说明
200 OK

Insight

Success

Other Status Codes

ErrorResponse

错误

Headers

x-ms-error-code: string

安全性

Authorization

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

Type: apiKey
In: header

示例

Insights_Get

Sample Request

GET {endpoint}/parties/PARTY123/models/modelId/resource-types/Farm/resources/farmId/insights/insightId?api-version=2023-11-01-preview

Sample Response

{
  "id": "insightId",
  "partyId": "pjparty",
  "resourceId": "farmId",
  "resourceType": "Farm",
  "modelId": "modelId",
  "modelVersion": "1.0",
  "insightStartDateTime": "2021-07-26T09:31:54Z",
  "insightEndDateTime": "2021-07-26T09:31:54Z",
  "measurements": {
    "additionalPropKey1": {
      "unit": "15m/s",
      "value": 0
    }
  },
  "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-11-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId",
  "createdDateTime": "2021-07-26T11:19:11Z",
  "modifiedDateTime": "2021-07-26T11:19:11Z",
  "eTag": "00000000-0000-0000-8210-0ef9229601d7",
  "name": "insightName",
  "description": "insightDescription",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定义

名称 说明
Error

Azure AgPlatform 服务出错。

ErrorResponse

来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

FarmHierarchyResourceType

与记录关联的资源类型。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object

Insight

见解资源的架构。

Measure

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

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 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

名称 类型 说明
error

Error

Azure AgPlatform 服务出错。

traceId

string

唯一跟踪 ID。

FarmHierarchyResourceType

与记录关联的资源类型。

名称 类型 说明
Farm

string

Field

string

Party

string

SeasonalField

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

Insight

见解资源的架构。

名称 类型 说明
attachmentsLink

string

获取附件的链接。

createdBy

string

由用户/租户 ID 创建。

createdDateTime

string

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

description

string

资源的文本说明。

eTag

string

实现乐观并发的 ETag 值。

id

string

资源的 ID。

insightEndDateTime

string

见解相关的结束日期。

insightStartDateTime

string

与见解相关的开始日期。

measurements

<string,  Measure>

用于捕获见解结果的度量值。

modelId

string

关联模型的 ID。

modelVersion

string

关联模型的版本。

modifiedBy

string

由用户/租户 ID 修改。

modifiedDateTime

string

上次修改资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。

name

string

用于标识资源的名称。

partyId

string

关联方 ID。

properties

属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。

resourceId

string

关联资源的 ID。

resourceType

FarmHierarchyResourceType

与记录关联的资源类型。

status

string

资源的状态。

Measure

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

名称 类型 说明
unit

string

数据单位。

value

number

数据值。