非同期実行API：GetStatus
- 公開日
- 更新日 2025-03-06
利用条件
ベーシックAPI（申込不要）
概要
API名称
AsyncApi
カテゴリー
説明
非同期APIの実行ステータスや実行結果の取得を行います。
添付ファイル
関連メソッド
データの更新頻度
ー
リクエスト
新URL
New!
https://api.wagri2.net/Async/GetStatus?RequestId={RequestId}
旧URL（2025年度末で終了予定）
https://api.wagri.net/API/AsyncApi/GetStatus?RequestId={RequestId}
説明
要求IDに対応する非同期APIの実行ステータスを取得します。
HTTPメソッド
GET
パラメータ
URLデータ定義
StaticAPI: GET API/AsyncApi/GetStatus?RequestId={RequestId}
| 名称 | 型 | サイズ | 値の説明 |
|---|---|---|---|
| RequestId | 要求ID | string |
URL説明
GET API/AsyncApi/GetStatus?RequestId={RequestId} Url
新呼出例
New!
https://api.wagri2.net/Async/GetStatus?RequestId=dc8e1131-3a05-4909-86e0-b81f63f71868
旧呼出例（2025年度末で終了予定）
ー
レスポンス
レイアウト
レスポンスデータ定義
非同期APIの実行ステータス
| 名称 | 型 | サイズ | 値の説明 |
|---|---|---|---|
| RequestId | 要求ID | string, null | |
| Status | 実行状態 (Request, Start, End, Error) | string, null | |
| RequestDate | 要求開始日 | string, null | Format: date-time |
| EndDate | 終了日 | string, null | Format: date-time |
レスポンス説明
GET API/AsyncApi/GetStatus?RequestId={RequestId} Response
レスポンス例
ー
ステータスコード
| コード | 名称 | 値の説明 |
|---|---|---|
| 200 | OK | リクエストが成功しました。 |
| 400 | Bad Request | リクエストが不正です。 |
| 401 | Unauthorized | 認証情報が不正です。 |
| 403 | Forbidden | リソースのアクセスが禁止されています。 |
| 404 | Not Found | リソースが見つかりませんでした。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
サンプルソースコード
プログラム記述例（WAGRI共通）
import requests
url = "https://api.wagri.net/API/Public/AgriculturalLand/SearchByCityCode"
payload = {
'CityCode': '432041'
}
headers = {
'X-Authorization': 'アクセストークン',
}
response = requests.get(url, headers=headers, params=payload)
print(response.text)
プログラム記述例（個別API）
ー