一般タスク一覧の照会

この記事の内容
  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/list 専有クラウドをご利用の企業は、専有クラウドのアドレスを使用してください。
HTTP Method POST

リクエストヘッダー

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

リクエストボディ

名称 タイプ 説明 必須かどうか 説明
key string 検索キーワード いいえ 現在はタスク名のあいまい検索に使用されます。
enabled boolean 有効かどうか いいえ タスクが有効かどうかを指定します。
scheduleType string タスクタイプ いいえ タスクタイプの列挙値の説明を参照してください。
page number ページ番号 いいえ デフォルト値は1で、1ページ目から始まります。
size number 1ページあたりの件数 いいえ デフォルト値は20で、1ページあたり20件です。この値の上限は500です。

リクエストの例

{
  "key":"测试",
  "enabled":true,
  "type":"period",
  "page":1,
  "size":10,
  "orderBy":"createTime"
}

レスポンス

レスポンスボディ

名称 タイプ 必須かどうか 説明
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
∟ 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の記事一覧ページの先頭へ ↑