単一タスクの実行履歴一覧

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

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

事前操作

​ 1.タスク一覧APIでscheduleUuidを取得し、sourceUuidとして渡します

説明: このAPIは単一タスクの実行履歴を取得します。特定のタスクをクリックしたときに、そのタスクのすべての実行履歴を表示するために使用できます(連続スクロール形式で表示します)。ページを飛ばして移動することはできません。

テンプレート

postManテンプレート

Javaテンプレート

​ リクエストモデル:

​ レスポンスモデル:

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

リクエスト

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

リクエストヘッダー

基本 説明
Authorization Bearer {accessToken} {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります
Content-Type application/json

リクエストボディ

名称 型 説明 必須かどうか 説明
sourceUuid string 発生元uuid はい タスクuuid
statusList array タスクの実行状態の集合 いいえ タスクの実行状態の説明を参照してください
string 子項目 いいえ
startTime string 開始日時 いいえ 開始日時です。トリガー日時を基準に検索します
endTime string 終了日時 いいえ 終了日時です。トリガー日時を基準に検索します
cursorId number ページ分割用カーソルid いいえ 最初のページでは渡す必要はありません。次のページをクリックするときは、前のページの最後のレコードのidを渡す必要があります。前のページをクリックするときは、前回のリクエストで取得した最初のレコードのidを指定します
cursorDirection string ページ移動の方向 はい pre:前のページをクリック、next:次のページをクリックです。最初のページではデフォルトでnextです
size number 1ページあたりの件数 はい number 1ページあたりの件数

リクエスト例

{
  "sourceUuid":"4d8aae66-cec5-4043-85cc-70f4e0430111",
  "startTime":"2022-05-15 17:50:00",
  "endTime":"2022-05-16 17:50:00",
  "statusList":["finish","running"],
  "cursorId":123,
  "cursorDirection": "next",
  "size":10
}

レスポンス

レスポンスボディ

名称 型 必須かどうか 説明
code int はい ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明
success boolean はい 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます
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 はい タスクの実行状態です。このフィールドでタスクが終了状態にあるかどうかを判断できます。終了状態の場合は、このAPIのポーリングを停止する必要があります。タスクの実行状態の列挙値の説明を参照してください
∟ 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

レスポンスボディの例

statusは、ポーリングを停止するための判定に使用できます。終了状態になった場合は、ポーリングを停止する必要があります。ロボットの実行状態の列挙値の説明を参照してください。

エラーが発生した場合は、ステータスコードの説明に移動してください

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