一般タスク詳細の照会

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

タスク詳細の照会

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

事前操作

​ 次の認証インターフェースを使用してaccessTokenを取得し、対応するヘッダーに入力する必要があります。

説明: このインターフェースは、単一のタスクの詳細を照会します。ユーザーが独自のタスク管理機能を構築する場合に適しています。

テンプレート

postManテンプレート

Javaテンプレート

​ リクエストモデル:

​ レスポンスモデル:

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

リクエスト

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

リクエストヘッダー

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

リクエストボディ

名称 タイプ 説明 必須かどうか 説明
scheduleUuid string タスクのuuid はい タスク一覧インターフェースから取得します。

リクエストの例

{
  "scheduleUuid":"xxx"
}

レスポンス

レスポンスボディ

名称 タイプ 必須かどうか 説明
code int はい ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明
success boolean はい 呼び出しが成功したかどうかを示します。このフィールドに基づいて、インターフェースの呼び出しが成功したかどうかを判断できます。
msg string はい ステータスコードの説明
data object はい レスポンスデータ
∟ scheduleUuid string はい タスクのuuid
∟ scheduleName string はい タスクの名称
∟ scheduleType string はい タスクタイプです。参照:タスクタイプの列挙値の説明
∟ createTime string はい 作成日時 yyyy-mm-dd hh:MM:ss
∟ updateTime string はい 更新日時 yyyy-mm-dd hh:MM:ss
∟ clientScope string はい 実行ロボットの選択範囲です。参照:実行ロボットの選択範囲
∟ executeScope string はい 実行ロボットの実行方針 実行ロボットの実行方針の列挙値の説明
∟ creatorName string はい 作成者のアカウント
∟ creatorUuid string はい 作成者のuuid
∟ modifierName string はい 変更者のアカウント
∟ modifierUuid string はい 変更者のuuid
∟ enabled boolean はい タスクを有効にするかどうか
∟ enabledWaitTimeout boolean はい 待機タイムアウト設定を有効にするかどうか
∟ errorProcess string はい エラー時の実行方針 異常時の実行方針の列挙値の説明
∟ newestTaskUuid string いいえ 直近のタスク実行のuuid
∟ runTimes number はい 実行時間
∟ priority number はい 実行回数
∟ robotClientList array はい 実行ロボットに関する情報
∟ uuid string** ** はい 実行ロボットのuuid
∟ robotClientName string いいえ 実行ロボットの名称です。実行ロボットが削除された場合は空になります。
∟ robotList array はい ロボットに関する情報
∟ enableRunTimeout boolean はい ロボットの実行タイムアウト設定を有効にするかどうか
∟ icon string いいえ アイコン
∟ robotName string いいえ ロボットの名称です。ロボットが削除された場合は空になります。
∟ robotUuid string いいえ ロボットのuuidです。ロボットが削除された場合は空になります。
∟ supportParam boolean はい ロボットのパラメータをサポートするかどうか
∟ settings array いいえ supportParam = trueの場合、 ロボットのメインフローパラメータは空ではありません。
∟ inputs array いいえ ロボットのメインフローの入力パラメータ
∟ description string いいえ パラメータの説明
∟ direction string いいえ パラメータの方向です。Outは出力パラメータ、Inは入力パラメータを示します。
∟ name string いいえ パラメータ名
∟ type string いいえ パラメータタイプです。ロボットタイプのパラメータタイプの列挙値の説明を参照してください。
∟ value string いいえ パラメータ値
∟ outputs array いいえ ロボットのメインフローの出力パラメータ
∟ description string いいえ パラメータの説明
∟ direction string いいえ パラメータの方向です。Outは出力パラメータ、Inは入力パラメータを示します。
∟ name string いいえ パラメータ名
∟ type string いいえ パラメータタイプです。ロボットタイプのパラメータタイプの列挙値の説明を参照してください。
∟ value string いいえ パラメータ値
∟ userGrantList array はい タスクのユーザー権限付与に関する情報
∟ userUuid string はい ユーザーのuuid
∟ accountName string はい ユーザーのアカウント名
∟ waitTimeoutSettings object はい タイムアウト設定
∟ waitTimeoutDay number いいえ 待機タイムアウト(日単位)
∟ waitTimeoutHour number いいえ 待機タイムアウト(時間単位)
∟ waitTimeoutMin number いいえ 待機タイムアウト(分単位)
∟ cronInterface object はい タイマー
∟ cronExpress string いいえ cron式
∟ dayOfWeeks number いいえ 曜日
∟ hour number いいえ 時間
∟ minimumIntervalSeconds number いいえ 最小秒数
∟ minute numner いいえ 分
∟ month numner いいえ 月
∟ nextTime string いいえ 次回のトリガー日時 yyyy-mm-dd hh:MM:ss
∟ time string いいえ 時分秒
∟ type string いいえ タイマータイプです。参照:タイマータイプの列挙値の説明

レスポンスボディの例

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

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