- ホワイトクラウド ASPIRE
- サービスご利用ガイド
- APIを利用する
- APIリファレンス
- 処理
- 処理ステータス取得
処理ステータス取得
タスクIDからタスクの情報を取得します。
GET /api/1.0/task/{taskId}
※ taskId :確認したい処理のタスクID
| Request parameters | ||||
|---|---|---|---|---|
| Name | Description | Type | Data type | Required |
| Authorization | Bearer [APIキー] | header | String | True |
| Successful Response | |||
|---|---|---|---|
| Response Code | 200 OK | ||
| Response Headers | Content-type: application/json | ||
| Name | Description | Example | Data type |
| task | タスク情報 | Object | |
| status | ステータス | SUCCESS | String |
| progressPercentage | 進捗率 | 100 | Number |
| targetId | ターゲットID ※作成されたオブジェクトのID |
e4dd6ed6c9d24f1dac6b551a7ff60fd6 | String |
| acceptedDate | 受付日時 | 2023-04-06T11:49:58+0900 | String |
| startedDate | 開始日時 | 2023-04-06T11:51:58+0900 | String |
| finishedDate | 終了日時 | 2023-04-06T11:55:58+0900 | String |
| Result | 結果 | OK | String |
| 実行例 |
|---|
|
# Execute request curl -i -X GET -H "Authorization:$token" -H "Content-Type:application/json" ¥ "https://eastapi.aspire.gcf.whitecloud.jp/api/1.0/task/ b107...094822aa91344...49107c" |
| レスポンス例 |
|---|
|