ロボットの実行を停止する

この記事の内容
  1. 事前の操作
  2. テンプレート
  3. Postman テンプレート
  4. Java テンプレート
  5. リクエスト
  6. リクエストヘッダー
  7. リクエストボディ
  8. リクエスト例
  9. レスポンス
  10. レスポンスボディ
  11. レスポンス例
  12. job の実行にメインフローの入力・出力パラメータがある場合

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

事前の操作

先にロボットを起動する APIを呼び出し、jobUuid を取得する必要があります。

注:実行状態が終端状態の場合、この API を呼び出しても効果はありません。

テンプレート

Postman テンプレート

ロボット実行停止 API の JSON テンプレート(右クリックして保存)

Java テンプレート

リクエストモデル:StopJobReq.java(右クリックして保存)

レスポンスモデル:なし

リクエスト

基本項目 値 説明
HTTP URL https://api.example.com/oapi/dispatch/v2/job/stop プライベートクラウドを利用する企業は、その環境のアドレスを使用してください。
HTTP Method POST

リクエストヘッダー

基本項目 値 説明
Authorization Bearer {accessToken} {accessToken} を、認証 API が返した accessToken に置き換えてください。
Content-Type application/json

リクエストボディ

名前 型 説明 必須 補足
jobUuid string ロボット実行の UUID はい なし

リクエスト例

{
  "jobUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0"
}

レスポンス

レスポンスボディ

名前 型 必須 説明
code int はい ステータスコード。200 は成功、200 以外は失敗を表します。ステータスコードの説明を参照してください。
success boolean はい 呼び出しが成功したかを示します。このフィールドで API の成否を判定できます。
msg string はい ステータスコードの説明。

レスポンス例

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

job の実行にメインフローの入力・出力パラメータがある場合
{
    "code": 200,
    "success": true
}

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

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