- API (データ&プログラム) -API(data&program)

非同期実行API:GetStatus

提供ベンダー:
システム名:
WAGRI運営事務局
利用条件:
WAGRI会員は無償

概要

API名称
AsyncApi
説明

非同期APIの実行ステータスや実行結果の取得を行います。

データの更新頻度
カテゴリー
添付ファイル

関連メソッド

リクエスト

URL

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

呼出例

レスポンス

レイアウト

レスポンスデータ定義
非同期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 サーバー内部でエラーが発生しました。

サンプルソースコード

ソースコード

前に戻る
上部へスクロール