機能
実行された非同期処理の一覧
処理概要
実行された非同期処理の一覧を表示します。
非同期処理とはレスポンスがステータスコード202で復帰した要求です。
パラメーター
パラメーター名 | 説明 | 指定 | 形式 | タイプ |
---|---|---|---|---|
token | 認証トークン | 必須 | string | query |
filter_cols | フィルターするカラム名を指定します。 | 任意 | string | query |
filter_vals | filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。 | 任意 | string | query |
sort_cols | ソートするカラム名を指定します。 | 任意 | string | query |
sort_vals | sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。
[例] | 任意 | string | query |
show_cols | 表示するカラム名を指定します。 | 任意 | string | query |
hide_cols | 非表示にするカラム名を指定します。 | 任意 | string | query |
limit | 表示する項目数を指定します。 | 任意 | integer | query |
offset | 項目の表示開始位置を指定します。 | 任意 | integer | query |
ステータスコード
本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。
200
ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。
レスポンス詳細
JSON形式のレスポンスとして表示されます。
データを格納するキー名: requests
オブジェクトの配列を返却
表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。
コード | キー | 説明 | 表示 | 形式 | 列挙型定数 |
---|---|---|---|---|---|
200 | id | 処理のID | Yes | integer | |
last_updated_at | 最後更新日時 | Yes | timestamp | ||
submitted_at | 操作実施日時 | No | timestamp | ||
started_at | 処理開始日時 | No | timestamp | ||
completed_at | 処理完了日時 | No | timestamp | ||
action | 処理名 | Yes | string | ||
action_parameter | 処理のパラメーター | No | string | ||
target_name | 操作対象名 | Yes | string | ||
user_name | ユーザー名 | Yes | string | ||
call_from | 呼出し元 | No | string | ||
phase | 処理の進行状態 | Yes | enum | Submit: Start: Complete: | |
operation_result | 処理の結果 | Yes | enum | Success: Warning: Failed: | |
status | 処理の状態 | Yes | enum | Submit: Start: Success: Warning: Failed: | |
message | メッセージ | No | string |
機能
実行された非同期処理の詳細表示
処理概要
実行された非同期処理の詳細を表示します。
パラメーター
パラメーター名 | 説明 | 指定 | 形式 | タイプ |
---|---|---|---|---|
token | 認証トークン | 必須 | string | query |
id | 処理のID | 必須 | integer | path |
ステータスコード
本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。
200
ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。
レスポンス詳細
JSON形式のレスポンスとして表示されます。
データを格納するキー名: request
単一のオブジェクトを返却
表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。
コード | キー | 説明 | 形式 | 列挙型定数 |
---|---|---|---|---|
200 | id | 処理のID | integer | |
last_updated_at | 最後更新日時 | timestamp | ||
submitted_at | 操作実施日時 | timestamp | ||
started_at | 処理開始日時 | timestamp | ||
completed_at | 処理完了日時 | timestamp | ||
action | 処理名 | string | ||
action_parameter | 処理のパラメーター | string | ||
target_name | 操作対象名 | string | ||
user_name | ユーザー名 | string | ||
call_from | 呼出し元 | string | ||
phase | 処理の進行状態 | enum | Submit: Start: Complete: | |
operation_result | 処理の結果 | enum | Success: Warning: Failed: | |
status | 処理の状態 | enum | Submit: Start: Success: Warning: Failed: | |
message | メッセージ | string |