ロボットの実行ログの検索通知
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
先にロボットのスタートアップAPIを呼び出すか、他の方法でjobUuidを取得する必要があります。
テンプレート
postManテンプレート
Javaテンプレート
リクエストモデル:
レスポンスモデル:
リクエスト
| 基本 | 説明 | |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/job/log/notify | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | 説明 | |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります |
| Content-Type | application/json |
リクエストボディ
| 名称 | 型 | 説明 | 必須かどうか | 説明 |
|---|---|---|---|---|
| jobUuid | string | ロボット実行uuid | はい | ロボットのスタートアップAPIで取得します |
| page | int | ページ番号 | いいえ | デフォルトは最初のページです |
| size | int | 1ページあたりの件数 | いいえ | デフォルトは20件です |
| queryFilter | ||||
| ∟ beginTime | string | 終了日時 | いいえ | 開始日時 |
| ∟ endTime | string | 開始日時 | いいえ | 終了日時 |
| ∟ searchKey | string | 検索キーワード | いいえ | 検索キーワード |
| ∟ sort | object | 並べ替えフィールド | いいえ | |
| ∟ sortKey | string | 並べ替えキー | いいえ | デフォルトはtimeです。現在はtimeのみ対応しています |
| ∟ sortOrder | string | 並べ替え順序 | いいえ | asc 昇順 desc 降順 |
リクエスト例
{
"jobUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0",
"page": 1,
"size": 20,
"queryFilter":{
"beginTime":"2024-03-20 11:11:11",
"endTime":"2024-03-20 11:11:12",
"searchKey":"商品検索",
"sort": {
"sortKey": "time",
"sortOrder": "desc"
}
}
}
レスポンス
レスポンスボディ
| 名称 | 型 | 必須かどうか | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、500は検索失敗、80204001は(ログを検索できないこと)を示します |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます |
| msg | string | はい | ステータスコードの説明 |
| data | string | はい | 今回のリクエストのrequestId |
レスポンスボディの例
{
"data": "5qwedqeasdc0zssadasdasdqwq",
"code": 200,
"success": true
}