ロボット実行記録の照会API
ロボット実行記録の照会
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
このAPIは、ロボットの実行記録をページ単位で取得するために使用します。
事前操作
- 認証APIを使用してaccessTokenを取得します。
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/app/open/query/use/record/list | |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります |
リクエストパラメータ
| 名称 | タイプ | 必須かどうか | 説明 |
|---|---|---|---|
| appId | String | いいえ | ロボットIDです。ロボットによる絞り込みと日時による絞り込みのいずれかを必ず指定してください |
| size | String | いいえ | 1ページあたりの件数です。デフォルトは30、最大は100です |
| minId | int | はい | カーソルページング用のフィールドです。毎回、前のページの最大idを開始idとして渡します。指定しない場合、minIdのデフォルトは0です |
| beginDate | String | いいえ | 開始日時です。日時による絞り込みとロボットによる絞り込みのいずれかを必ず指定してください |
| endDate | String | いいえ | 終了日時です。日時による絞り込みとロボットによる絞り込みのいずれかを必ず指定してください |
レスポンス
レスポンスデータ構造
| 名称 | タイプ | 説明 |
|---|---|---|
| code | integer | 結果コードです 200は成功、それ以外は失敗を表します |
| success | boolean | 呼び出しが成功したかどうかを表します。このフィールドでAPI呼び出しの成否を判断できます |
| requestId | string | リクエストID |
| msg | string | ステータスコードの説明 |
| data | [object] | 結果データ |
| |─id | number | 主キーidです。ページング時には、現在のページの最後のデータのidを渡す必要があります |
| |─ runRecordId | string | 実行記録の外部公開用主キー |
| |─ appId | string | ロボットid |
| |─ userName | string | アカウント |
| |─ startTime | string | 実行開始日時 |
| |─ endTime | string | 実行終了日時 |
| |─ updateTime | string | 同期日時 |
| |─ runStatusName | string | 実行状態 |
| |─ runStatus | string | 実行状態 |
| |─ runningTime | integer | 実行時間の長さ(秒) |
| |─ heartTime | string | ハートビート日時 |
| |─ appName | string | ロボット名 |
| |─ startMode | string | 起動方式 |
| |─ startModeName | string | 起動方式の名称 |
| |─ remark | string | エラーメッセージ |
| page | [PageDTO | ページング情報 |
| |─ total | integer | 総件数 |
| |─ size | integer | 1ページあたりの件数 |
| |─ page | integer | 現在のページ |
| |─ pages | integer | 総ページ数 |
| |─ offset | integer | オフセット |
| |─ sortColumn | string¦ | 並べ替えに使用するcolumnの名称 |
| |─ order | string¦ | 並べ替え方法はdesc/ascです。デフォルトでは降順に並べ替えます |
| code | integer | 結果コードです 200は成功、それ以外は失敗を表します |
| success | boolean | 呼び出しが成功したかどうかを表します。このフィールドでAPI呼び出しの成否を判断できます |
| requestId | string | リクエストidです。問題の調査に使用します |
| serverIp | string | 処理を行うサービスのIP |
| serverInstName | string | 処理を行うサービスインスタンスの名称 |
| msg | string | ステータスコードの説明 |
レスポンスデータの例
{
"data": [
{
"runRecordId": "360164898894159873",
"appId": "29deebe9-95fc-4bdd-a6ba-df362d7215e0",
"userName": "ceshi3@csqy1",
"startTime": "2024-05-07 20:46:43",
"endTime": "2024-05-07 20:46:44",
"updateTime": "24-5-7 下午8:46",
"runStatus": "finish",
"runningTime": 1,
"heartTime": "2024-05-07 20:46:44",
"appName": "kkkkkk",
"startMode": "manual",
"startModeName": "手工执行"
}
],
"code": 200,
"success": true,
"requestId": "8c7a95ea-4ee6-4f01-8bcb-0925658ac283"
}
使用例
curlの例
curl --location --request POST 'https://api.example.com/oapi/app/open/query/use/record/list' \ --header 'Authorization: Bearer 2eed910f-6ade-4e0c-9007-0feade4f5df6' \ \ --header 'Content-Type: application/json' \ --header 'Accept: */*' \ --header 'Host: api.example.com' \ --header 'Connection: keep-alive' \ --data-raw '{ "appId": "string", "size": "30", "minId": "0", "beginDate": "2024-05-15 00:00:00", "endDate": "2024-05-15 23:00:00" }'