Insights - Get

リファレンス

サービス:: Azure Data Manager for Agriculture

API バージョン:: 2023-11-01-preview

特定のパーティの指定された分析情報リソースを取得します。

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	エラーヘッダー x-ms-error-code: string

名前

型

説明

200 OK

Insight

Success

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに有効なベアラートークンを指定してください。以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

Insights_Get

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "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 サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
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 サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名前	型	説明
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	データ値。

次の方法で共有

Insights - Get

URI パラメーター

要求ヘッダー

応答

セキュリティ

Authorization

例

Insights_Get

要求のサンプル

応答のサンプル

定義

Error

ErrorResponse

FarmHierarchyResourceType

InnerError

Insight

Measure

その他のリソース