最新のタスク実行記録

この記事の内容
  1. 事前操作
  2. テンプレート
  3. postManテンプレート
  4. Javaテンプレート
  5. リクエスト
  6. リクエストヘッダー
  7. リクエストボディ
  8. リクエストの例
  9. レスポンス
  10. レスポンスボディ
  11. レスポンスボディの例

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

事前操作

​ 説明:このインターフェースは、各タスクの最新の実行記録を取得するために使用します。

説明: このインターフェースでは、パラメータを指定して、自社のすべてのロボットクライアントを絞り込んで照会できます。返されるフィールドには、状態、名称、ロボットクライアントが存在する端末の情報が含まれます。ロボットクライアント管理モジュールの構築や、アイドル状態のロボットクライアントを抽出してタスクを割り当てるために使用できます。

テンプレート

postManテンプレート

Javaテンプレート

​ リクエストモデル:

​ レスポンスモデル:

​ ロボット実行結果モデル:

リクエスト

基本 説明
HTTP URL https://api.example.com/oapi/dispatch/v2/task/newest/list 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください。
HTTP Method POST

リクエストヘッダー

基本 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証インターフェースが返すaccess Tokenに置き換える必要があります。
Content-Type application/json

リクエストボディ

名称 タイプ 説明 必須かどうか 説明
statusList array タスク実行状態の集合 いいえ タスク実行状態の説明を参照してください。
string 子項目 いいえ
startTime string 開始日時 いいえ 開始日時です。トリガー日時を基準に照会します。
endTime string 終了日時 いいえ 終了日時です。トリガー日時を基準に照会します。
page number ページ番号 いいえ ページ分割のパラメータで、何ページ目かを指定します。デフォルトは1です。
size number ページ数 いいえ ページ分割のパラメータで、1ページあたりの件数を指定します。デフォルトは20です。

リクエストの例

{
  "startTime":"2022-05-15 17:50:00",
  "endTime":"2022-05-16 17:50:00",
  "statusList":["finish","running"],
  "page":1,
  "size": 20
}

レスポンス

レスポンスボディ

名称 タイプ 必須かどうか 説明
code int はい ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明
success boolean はい 呼び出しが成功したかどうかを示します。このフィールドに基づいて、インターフェースの呼び出しが成功したかどうかを判断できます。
msg string はい ステータスコードの説明
data object はい レスポンスデータ
∟ cursorDirection string はい カーソルの方向です。nextは次のページ、preは前のページを示します。
∟ hasData boolean はい 次のページのデータがまだあるかどうかを示します。
∟ nextId number はい 次のページのid
∟ preId number はい 前のページのid
∟ dataList array はい タスクに関連付けられたロボットの実行情報です。ロボットが複数ある場合は複数件になります。
∟ createTime string はい 作成日時です。形式はyyyy-mm-dd hh:MM:ddです。
∟ updateTime string はい 更新日時です。形式はyyyy-mm-dd hh:MM:ddです。
∟ executeScope string はい ロボットクライアントの実行方針です。ロボットクライアント実行方針の列挙値の説明を参照してください。
∟ clientScope string
∟ taskName string はい タスク実行の名称です。taskNameと同じです。
∟ id numer はい タスク実行のid
∟ sourceUuid string はい 実行元のuuidです。通常はscheduleUuidです。
∟ sourceType string はい 実行元のタイプです。実行元の列挙値の説明を参照してください。
∟ status string はい タスクの実行状態です。このフィールドでタスクが最終状態かどうかを判断できます。最終状態の場合は、このインターフェースのポーリングを停止する必要があります。タスク実行状態の列挙値の説明を参照してください。
∟ taskUuid string はい タスク実行のuuidです。sceneInstUuidと同じです。
∟ userUuid string はい トリガーしたユーザーのuuid
∟ userName string いいえ トリガーしたユーザーの名称
∟ runTimes number はい タスクの実行回数
∟ taskClients array はい sceneInstClientsと同じです。
∟ clientIp string いいえ ロボットクライアントのIPアドレス
∟ robotClientStatus string はい ロボットクライアントの状態です。ロボットクライアント状態の列挙値の説明を参照してください。
∟ currentRobotUuid string いいえ 現在実行中の参照のuuid
∟ currentRobotName string いいえ 現在実行中のロボットの名称
∟ description string いいえ ロボットクライアントの備考名称
∟ robotClientName string いいえ ロボットクライアントの名称
∟ robotClientUuid string いいえ ロボットクライアントのuuid

レスポンスボディの例

エラーが発生した場合は、次を参照してください:ステータスコードの説明

OpenAPIの記事一覧ページの先頭へ ↑