ロボットの実行記録の照会
この記事の内容
ロボットの実行記録のページ単位での照会
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
このAPIは、現在のテナントに属するロボットの実行記録をページ単位で照会します。ロボットID、ユーザーID、実行方式による絞り込みをサポートしています。照会対象の期間(maxTime-minTime)は7日を超えることができません。
事前操作
1. 認可APIを使用してaccessTokenを取得します。
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/app/open/query/pageRunRecordData | |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認可APIから返されたaccess Tokenに置き換える必要があります |
| Content-Type | application/json |
リクエストパラメータ
JSON形式でリクエスト本文(Body)としてパラメータを渡します。
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| appId | String | いいえ | ロボットIDです。照会するロボットを指定します。渡さない場合は、現在のテナントに属するすべてのロボットを照会します |
| minTime | Date | はい(ビジネスロジック層で検証します。フレームワーク層では非空検証は行われません) | 照会対象の最小日時(その日時を含む)です。maxTimeとの差は7日を超えることができません。形式:yyyy-MM-dd HH:mm:ss |
| maxTime | Date | はい(ビジネスロジック層で検証します。フレームワーク層では非空検証は行われません) | 照会対象の最大日時(その日時を含む)です。minTimeとの差は7日を超えることができません。形式:yyyy-MM-dd HH:mm:ss |
| userId | String | いいえ | 実行ユーザーIDで絞り込みます |
| startModelList | Array[String] | いいえ | 実行方式の絞り込みリストです。指定可能な値:schedule(スケジュール)、Trigger(トリガー)、Manual(手動実行)、Autorun(自動実行)、Assistant(スケジューリング)、emailtrigger(メールトリガー)、filetrigger(ファイルトリガー)、hotkeytrigger(ホットキートリガー) |
| page | Integer | いいえ | 現在のページ番号です。デフォルト値は1です |
| size | Integer | いいえ | 1ページあたりの件数です。デフォルト値は10です |
| needCount | Boolean | いいえ | (現在、このAPIではこのフィールドを使用していません。総件数は常に集計されるため、値を渡しても効果はありません) |
説明:このAPIでは、@Validによるフレームワークレベルのパラメータ検証を使用していません。minTime/maxTimeが空の場合、または期間が7日を超える場合は、標準の400検証エラーではなく、ビジネスロジック層で対応するエラーコードが送出されます(以下のエラーコード一覧を参照してください)。
レスポンス
レスポンスデータ構造
| 名称 | タイプ | 説明 |
|---|---|---|
| data | object | 結果データです(ページネーションオブジェクトです。注意:ページネーション情報はdataと同じ階層ではなく、dataの内部にネストされています) |
| ├─ pageDTO | object | ページネーション情報です |
| ├─ total | integer | 総件数です |
| ├─ size | integer | 1ページあたりの件数です |
| ├─ page | integer | 現在のページです |
| ├─ pages | integer | 総ページ数です |
| ├─ offset | integer | オフセットです |
| ├─ sortColumn | string | 並べ替えに使用するcolumnの名称です |
| ├─ order | string | 並べ替えの調整方法はdesc/ascです。デフォルトは降順です |
| ├─ result | array | 実行記録の一覧です |
| ├─ appId | string | ロボットIDです |
| ├─ appName | string | ロボットの名称です。対応するバージョン情報が見つからない場合はnullです |
| ├─ userName | string | 実行アカウントです。対応するユーザー情報が見つからない場合はnullです |
| ├─ startTime | string | 開始日時です |
| ├─ endTime | string | 終了日時です |
| ├─ updateTime | string | 同期日時です(このAPIではこのフィールドに値を設定していないため、常にnullを返します) |
| ├─ runStatus | string | 実行状態のコードです。元の記録の状態が空でない場合にのみ値が設定されます |
| ├─ runStatusName | string | 実行状態です(このAPIではこのフィールドに値を設定していないため、常にnullを返します) |
| ├─ runStatusDesc | string | 実行状態の説明です。runStatusが空でない場合にのみ値が設定されます |
| ├─ runningTime | integer | 実行時間です。単位:秒(開始日時と終了日時が同じ秒に収まる場合は、0と表示されるのを避けるため、自動的に1秒加算します) |
| ├─ runScene | string | 実行シーンです。編集状態での手動実行の場合は常に「編集中の手動実行」となり、それ以外は実行方式に対応する名称を使用します |
| code | integer | 戻り値の結果コードです。200は成功、その他は失敗を表します |
| success | boolean | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| requestId | string | リクエストIDです。問題の調査に使用できます |
| serverIp | string | 処理を行うサービスのIPです |
| msg | string | ステータスコードの説明です |
説明:このAPIのページネーション情報はdata.pageDTOにあり、記録一覧はdata.resultにあります。本プロジェクトのその他のページネーションAPI(ページネーション情報がdataと同じ階層のpageフィールドにあります)とは構造が異なるため、連携時には区別してください。
レスポンスデータの例
| { "data": { "pageDTO": { "total": 1, "size": 10, "page": 1, "pages": 1, "offset": 0, "sortColumn": null, "order": "desc" }, "result": [ { "appId": "107f0f23-3584-4b1b-8665-443605722f95", "appName": "kkkkk", "userName": "ceshiz@csqy1", "startTime": "2024-05-08 13:49:13", "endTime": "2024-05-08 13:50:24", "updateTime": null, "runStatus": "success", "runStatusName": null, "runStatusDesc": "运行成功", "runningTime": 71, "runScene": "手工执行" } ] }, "code": 200, "success": true, "requestId": "2f296259-d953-4939-9701-bc28ac43e002", "serverIp": "10.10.1.21", "msg": null } |
|---|
発生する可能性のあるエラーコード
| code | 説明 |
|---|---|
| 401 | 認可されていません。accessTokenが無効か、指定されていません。先に認可を完了してaccessTokenを取得する必要があります |
| 80101091 | 期間を完全に指定する必要があります(minTimeまたはmaxTimeが空です) |
| 80101105 | 期間は7日を超えることができません(maxTime-minTimeが7日を超えています) |
使用例
curlの例
| curl --location --request POST 'https://api.example.com/oapi/app/open/query/pageRunRecordData' \ --header 'Authorization: Bearer {accessToken}' \ --header 'Content-Type: application/json' \ --data-raw '{ "appId": "{appId}", "minTime": "2024-05-01 00:00:00", "maxTime": "2024-05-08 23:59:59", "page": 1, "size": 10 }' |
|---|