Weather Data - Get

リファレンス

サービス:: Azure Data Manager for Agriculture

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

WeatherData の一覧を返します。

POST {endpoint}/weather-data:fetch?api-version=2023-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
api-version	query	True	string	要求された API バージョン

要求ヘッダー

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

要求本文

名前	必須	型	説明
extensionApiName	True	string	要求を行う拡張 API 名。
extensionId	True	string	providerInput に使用する拡張機能の ID。例: Dtn。ClearAg。
units	True	string	データプロバイダーへの要求を送信する単位。サポートされている値は、英語単位の場合は 'e'、メートル単位の場合は 'm'、ハイブリッドユニット (英国) の場合は 'h'、メートル SI 単位の場合は 's' です。
additionalParams		AdditionalProviderParameters	気象データプロバイダー要求の追加パラメーターのスキーマ。
credentials		ApiKeyAuthCredentials	API Key ベースの認証用の Api Key Auth Credentials クラス。
duration		integer	日単位の予測応答が返される日数を指定します。使用可能な値は、1、5、10、25、45 です。 (Azure Weather Maps 拡張機能にのみ適用されます)。
endTimeHours		integer	時間範囲の終了。 (DTN にのみ適用されます。ClearAg 拡張機能。)
language		string	データプロバイダーから検索結果を返す言語 (IETF BCP 47 言語タグ)。例: 'en-US'、'es'、'es-MX'、'fr-FR'。
locations		WeatherLocation[]	プロバイダーから気象データをフェッチする必要がある場所の一覧。
startTimeHours		integer	時間範囲の開始。 Hour 0 は現在の時間を表します。 (DTN にのみ適用されます。ClearAg 拡張機能。)

応答

名前	型	説明
200 OK	WeatherDataProviderResponse	Success
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

200 OK

WeatherDataProviderResponse

Success

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

例

WeatherData_Get

要求のサンプル

HTTP

POST {endpoint}/weather-data:fetch?api-version=2023-11-01-preview

{
  "extensionId": "IBM.TWC",
  "extensionApiName": "currents-on-demand",
  "locations": [
    {
      "type": "LatLong",
      "value": "33,-97"
    }
  ],
  "language": "en-US",
  "units": "e",
  "credentials": {
    "kind": "ApiKeyAuthCredentials",
    "apiKey": {
      "keyVaultUri": "https://<keyvaultname>.vault.azure.net/",
      "keyName": "string",
      "keyVersion": "string"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "weatherMetadata": {
    "extensionVersion": "1.0",
    "weatherDataType": "current",
    "extensionId": "IBM.TWC",
    "extensionApiName": "currents-on-demand",
    "units": "e"
  },
  "status": "Succeeded",
  "locations": [
    {
      "location": {
        "type": "LatLong",
        "value": "33,-97"
      },
      "lastRefreshedDateTime": "2023-02-09T13:02:20Z",
      "data": {
        "dayOfWeek": [
          "Wednesday"
        ],
        "dayOrNight": [
          "Night"
        ],
        "pressureMeanSeaLevel": {
          "unit": "inches of mercury",
          "value": [
            1021.1
          ]
        },
        "relativeHumidity": {
          "unit": "percentage",
          "value": [
            84
          ]
        },
        "temperature": {
          "unit": "fahrenheit",
          "value": [
            49
          ]
        },
        "temperatureDewPoint": {
          "unit": "fahrenheit",
          "value": [
            44
          ]
        },
        "temperatureFeelsLike": {
          "unit": "fahrenheit",
          "value": [
            47
          ]
        },
        "temperatureHeatIndex": {
          "unit": "fahrenheit",
          "value": [
            49
          ]
        },
        "temperatureWindChill": {
          "unit": "fahrenheit",
          "value": [
            47
          ]
        },
        "uvDescription": [
          "Low"
        ],
        "uvIndex": [
          0
        ],
        "visibility": {
          "unit": "miles",
          "value": [
            10
          ]
        },
        "windDirection": {
          "unit": "degree",
          "value": [
            150
          ]
        },
        "windGust": {
          "unit": "miles/hour",
          "value": [
            0
          ]
        },
        "windSpeed": {
          "unit": "miles/hour",
          "value": [
            4
          ]
        },
        "additionalAttributes": {
          "cloudCoverPhrase": [
            "Partly Cloudy"
          ]
        }
      }
    }
  ],
  "errors": {
    "locations": []
  }
}

定義

名前	説明
AdditionalProviderParameters	気象データプロバイダー要求の追加パラメーターのスキーマ。
ApiKeyAuthCredentials	API Key ベースの認証用の Api Key Auth Credentials クラス。
AuthCredentialsKind	サポートされているさまざまな種類の AuthCredentials の列挙型。
Error	Azure AgPlatform サービスからのエラー。
ErrorForLocation	失敗した場所のエラー情報のモデル。
ErrorResponse	Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
KeyVaultProperties	キーコンテナーのプロパティ。
LocationType	場所の種類例: LatLong/IataCode/IcaoCode/Placeid/PostalKey。
Measures	測定値と単位を格納するためのスキーマ。
Status	Succeeded、Failed、または PartiallySucceeded 応答を示します。
WeatherDataErrors	失敗したすべての場所で発生したエラーのモデル。
WeatherDataForPassthrough	気象データのスキーマ。
WeatherDataProviderRequest	気象データプロバイダー要求のスキーマ。
WeatherDataProviderResponse	天気データプロバイダーの応答のスキーマ。
WeatherLocation	場所データのスキーマ。
WeatherLocationData	WeatherLocationData データのスキーマ。
WeatherMetadata	Weather メタデータのスキーマ。

AdditionalProviderParameters

気象データプロバイダー要求の追加パラメーターのスキーマ。

名前	型	規定値	説明
details	boolean	True	詳細 (AzureWeatherMaps にのみ適用されます)。
iconResolution	string		アイコンの解決 (AzureWeatherMaps にのみ適用されます)。

ApiKeyAuthCredentials

API Key ベースの認証用の Api Key Auth Credentials クラス。

名前	型	説明
apiKey	KeyVaultProperties	キーコンテナーのプロパティ。
kind	string: ApiKeyAuthCredentials	サポートされているさまざまな種類の AuthCredentials の列挙型。

AuthCredentialsKind

サポートされているさまざまな種類の AuthCredentials の列挙型。

名前	型	説明
ApiKeyAuthCredentials	string
OAuthClientCredentials	string

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	エラーのターゲット。

ErrorForLocation

失敗した場所のエラー情報のモデル。

名前	型	説明
code	integer	データプロバイダーによって返される状態コード。
description	string	エラーの説明。
location	WeatherLocation	場所データのスキーマ。
retryable	boolean	必要なデータをフェッチするために、同じ要求本文で再試行を行う必要があるかどうかを示すフラグ。

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。

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 してください。

KeyVaultProperties

キーコンテナーのプロパティ。

名前	型	説明
keyName	string	キーの名前Key Vault。
keyVaultUri	string	キーコンテナーの URI。
keyVersion	string	キーのバージョンKey Vault。

LocationType

場所の種類例: LatLong/IataCode/IcaoCode/Placeid/PostalKey。

名前	型	説明
IataCode	string
IcaoCode	string
LatLong	string
PlaceId	string
PostalKey	string

Measures

測定値と単位を格納するためのスキーマ。

名前	型	説明
unit	string	データ単位。
value	number[]	データ値。

Status

Succeeded、Failed、または PartiallySucceeded 応答を示します。

名前	型	説明
Failed	string
PartiallySucceeded	string
Succeeded	string

WeatherDataErrors

失敗したすべての場所で発生したエラーのモデル。

名前	型	説明
locations	ErrorForLocation[]	失敗したすべての場所で発生したエラーの一覧。

WeatherDataForPassthrough

気象データのスキーマ。

名前	型	説明
additionalAttributes		リソースに属するキー値ペアのコレクション。各ペアは、50 文字を超えるキーを持つ必要があり、250 文字を超える値を持つ必要があります。注: リソースに対して最大 100 個のキー値ペアを指定でき、サポートされているのは文字列と数字の値のみです。
cloudCover	Measures	測定値と単位を格納するためのスキーマ。
dayOfWeek	string[]	曜日。
dayOrNight	string[]	このデータフィールドは、場所の [ローカルの表示時間] に基づいて、昼間と夜間のどちらであるかを示します。
expirationTime	string[]	Utc 形式の有効期限。
hasPrecipitation	boolean[]	降水量があるかどうかを示します。
iconCode	integer[]	この数値は、天気アイコン検索のキーです。データフィールドには、観測された気象条件を表すために一致するアイコン番号が表示されます。
iconCodeExtend	integer[]	完全なセットの賢明な天気を表すコード。
pressureMeanSeaLevel	Measures	測定値と単位を格納するためのスキーマ。
relativeHumidity	Measures	測定値と単位を格納するためのスキーマ。
temperature	Measures	測定値と単位を格納するためのスキーマ。
temperatureDewPoint	Measures	測定値と単位を格納するためのスキーマ。
temperatureFeelsLike	Measures	測定値と単位を格納するためのスキーマ。
temperatureHeatIndex	Measures	測定値と単位を格納するためのスキーマ。
temperatureWindChill	Measures	測定値と単位を格納するためのスキーマ。
uvDescription	string[]	露出による皮膚損傷のリスクの関連レベルを提供することによって UV インデックス値を補完する UV インデックスの説明 (-2 = 使用できません、-1 = レポートなし、0 から 2 = 低、3 から 5 = 中、6 から 7 = 高、8 から 10 = 非常に高、11 から 16 = 極端)。
uvIndex	number[]	1 時間あたりの最大 UV インデックス。
validTime	string[]	時刻予測は Utc 形式で有効です。
validTimeLocal	string[]	時間予測は、現地の明らかな時刻で有効です。
visibility	Measures	測定値と単位を格納するためのスキーマ。
wetBulbTemperature	Measures	測定値と単位を格納するためのスキーマ。
windDirection	Measures	測定値と単位を格納するためのスキーマ。
windGust	Measures	測定値と単位を格納するためのスキーマ。
windSpeed	Measures	測定値と単位を格納するためのスキーマ。
wxPhraseLong	string[]	より長い説明を含む時間ごとの賢明な天気フレーズ。
wxPhraseShort	string[]	短い説明を含む時間ごとの賢明な天気フレーズ。

WeatherDataProviderRequest

気象データプロバイダー要求のスキーマ。

名前	型	説明
additionalParams	AdditionalProviderParameters	気象データプロバイダー要求の追加パラメーターのスキーマ。
credentials	ApiKeyAuthCredentials	API Key ベースの認証用の Api Key Auth Credentials クラス。
duration	integer	日単位の予測応答が返される日数を指定します。使用可能な値は、1、5、10、25、45 です。 (Azure Weather Maps 拡張機能にのみ適用されます)。
endTimeHours	integer	時間範囲の終了。 (DTN にのみ適用されます。ClearAg 拡張機能。)
extensionApiName	string	要求を行う拡張 API 名。
extensionId	string	providerInput に使用する拡張機能の ID。例: Dtn。ClearAg。
language	string	データプロバイダーから検索結果を返す言語 (IETF BCP 47 言語タグ)。例: 'en-US'、'es'、'es-MX'、'fr-FR'。
locations	WeatherLocation[]	プロバイダーから気象データをフェッチする必要がある場所の一覧。
startTimeHours	integer	時間範囲の開始。 Hour 0 は現在の時間を表します。 (DTN にのみ適用されます。ClearAg 拡張機能。)
units	string	データプロバイダーへの要求を送信する単位。サポートされている値は、英語単位の場合は 'e'、メートル単位の場合は 'm'、ハイブリッドユニット (英国) の場合は 'h'、メートル SI 単位の場合は 's' です。

WeatherDataProviderResponse

天気データプロバイダーの応答のスキーマ。

名前	型	説明
errors	WeatherDataErrors	失敗したすべての場所で発生したエラーのモデル。
locations	WeatherLocationData[]	すべての気象場所の気象データの一覧。
status	Status	Succeeded、Failed、または PartiallySucceeded 応答を示します。
weatherMetadata	WeatherMetadata	Weather メタデータのスキーマ。

WeatherLocation

場所データのスキーマ。

名前	型	説明
type	LocationType	場所の種類例: LatLong/IataCode/IcaoCode/Placeid/PostalKey。
value	string	場所値例: LocationType 型 "LatLong" の場合は "10,-25" です。

WeatherLocationData

WeatherLocationData データのスキーマ。

名前	型	説明
data	WeatherDataForPassthrough	気象データのスキーマ。
lastRefreshedDateTime	string	リソースが最後に要求された日時(サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
location	WeatherLocation	場所データのスキーマ。
requestCompletionTime	string	場所の要求完了時刻 (Utc)。

WeatherMetadata

Weather メタデータのスキーマ。

名前	型	説明
additionalParams	AdditionalProviderParameters	気象データプロバイダー要求の追加パラメーターのスキーマ。
duration	integer	日単位の予測応答が返される日数を指定します。使用可能な値は、1、5、10、25、45 です。 (Azure Weather Maps 拡張機能にのみ適用されます)。
endTimeHours	integer	時間範囲の終了。 (DTN にのみ適用されます。ClearAg 拡張機能。)
extensionApiName	string	要求を行う拡張 API 名。
extensionId	string	providerInput に使用する拡張機能の ID。例: Dtn。ClearAg。
extensionVersion	string	気象データ拡張機能のバージョン。
language	string	データプロバイダーから検索結果を返す言語 (IETF BCP 47 言語タグ)。例: 'en-US'、'es'、'es-MX'、'fr-FR'。
startTimeHours	integer	時間範囲の開始。 Hour 0 は現在の時間を表します。 (DTN にのみ適用されます。ClearAg 拡張機能。)
units	string	データプロバイダーへの要求を送信する単位。サポートされている値は、英語単位の場合は 'e'、メートル単位の場合は 'm'、ハイブリッドユニット (英国) の場合は 'h'、メートル SI 単位の場合は 's' です。
weatherDataType	string	気象データの種類 (予測/履歴)。

次の方法で共有

Weather Data - Get

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

WeatherData_Get

要求のサンプル

応答のサンプル

定義

AdditionalProviderParameters

ApiKeyAuthCredentials

AuthCredentialsKind

Error

ErrorForLocation

ErrorResponse

InnerError

KeyVaultProperties

LocationType

Measures

Status

WeatherDataErrors

WeatherDataForPassthrough

WeatherDataProviderRequest

WeatherDataProviderResponse

WeatherLocation

WeatherLocationData

WeatherMetadata

その他のリソース