API経由でOrchestratorのジョブを強制終了する方法

日本 ナレッジベース
1

Question/Problem

API経由でOrchestratorのジョブを強制終了する方法を知りたいです。

Resolution

以下の手順でAPI経由でのジョブの強制終了が可能です。

  1. https://[OCのホスト名]/swagger にアクセスします。

  2. Jobsという項目があるので、その中の「[GET] /odata/Jobs」を実行してJobの一覧を取得してください。「Try It out」＞「Execute」をクリックします。

  1. 対象のJobIDを控えます。例：“Id”:68081141となります。

  1. 「[POST] /odata/Jobs/UiPath.Server.Configuration.OData.StopJobs」を実行します。

5.bodyのJobIdsに3で控えたJobID、strategyにはKill、X-UiPath-OragnizationUnitIdに対象プロセスがあるフォルダIDを設定して「Try It out」>「Execute」をクリックします。
※フォルダIDはOrchestratorのフォルダにアクセスした際のURL (例：fid=227)より確認可能です。

6.ジョブが強制終了されます。
※強制終了するとジョブのState:Stoppedとなります。

APIの詳細につきましては以下の公式ガイドをご参照ください。

参考：
ジョブを終了する

※ジョブの強制終了ではなく、ジョブの停止を行いたい場合、5の手順でstrategyにSoftStopを記載することで可能です。