メインコンテンツまでスキップ

GetQueueList

タスクの処理状況を確認する

Description​

キューイングされているタスク処理から対象タスクの状況を確認します。

Method​

GET

Request URL Format​

/api/v0/tasks

Query Params​

all trueを指定しない場合は進行中のタスクしか取得できません（完了やエラーを確認するなどの場合はtrue推奨）
category タスクのカテゴリを指定
  - category: DatastoreCUDImport //ImportItems APIでappend:false を指定の場合
  - category: ReplaceImportData　//ImportItems APIでappend:true・replace_all:true を指定の場合
stream_id タスクのstream_idを指定

Request URL Sample​

GET https://api.xxx.com/api/v0/tasks?category=ReplaceImportData&all=true&stream_id=yc90927zl5Ba4nVoaJ0quE8QJ9IWoeZLbplKwzxkaL70t83GdOcmqzjioJVpFswwnCUbGF0ozWiCQm47Ww2GZSIGG7k1A3mK0mmLTaNc5xLgEG9j1i9zFqQHuC1Tk3Oc

Response Sample​

{
    "63992393b1ea5632b8bc0566": {
        "qt_id": "63992393b1ea5632b8bc0566",
        "category": "ReplaceImportData",
        "status": {
            "id": 2, // 0: 登録, 1: 進行中, 2: 完了, 3: エラー, 4: 異常
            "name": "StatusDone"
        },
        "created_at": "2022-12-14T01:14:59.125Z",
        "started_at": "2022-12-14T01:15:00.15Z",
        "finished_at": "2022-12-14T01:15:07.51Z",
        "metadata": {
            "w_id": "638da4dc8dfab6ae3cabf6aa",
            "p_id": "638da4dd8dfab6ae3cabf6ad",
            "d_id": "63916fb15690efdd69b806b6"
        }
    }
}