check_async_job

<< Click to Display Table of Contents >>

Navigation:  API V3 マニュアル > リファレンス > system >

check_async_job

非同期処理の結果もしくは進捗を取得します。

HTTP リクエスト

POST http://<ホスト名>/fileblog/api/v3/system/check_async_job
Authorization: Bearer <アクセストークン>
Content-Type: application/json; charset=utf-8
 
{
 async_job_id:"362F0DB245384E88BAAF3E471C56BEE8"
}

※アクセストークンについてはこちらをご覧ください。

リクエストパラメータ

名前

説明

async_job_id

String, 必須

各非同期処理で取得したasync_job_idを指定します。

レスポンス

HTTP/1.1 200 OK
{
 "job_response": {
         "tempfileid": 962370710
 },
 "status": "done"
}

リクエストが成功すると、レスポンスコードが200、レスポンスボディにJson形式で結果が返されます。

レスポンスパラメータ

名前

説明

job_response

String

各非同期処理の結果もしくは進捗がセットされます.内容はジョブによって異なります。

status

String

done,running,idle,aborted,のいずれかがセットされます。それぞれ, 処理完了、処理中、処理開始待ち、中断を表します。

エラーレスポンス

※エラーについてはこちらをご覧ください。