［RPA,UiPath］UiPath Orchestratorへのジョブ登録・実行手順概要

UiPath Orchestrator に対してプログラムからジョブを登録するようなものを想定しています。

手順

1. 認証（ログイン）

クラウド版：
POST /oauth/token によりアクセストークンを取得する

オンプレミス版：
POST /api/Account/Authenticate によりアクセストークンを取得する

（注）2021/02現在は使用できるものの@deprecatedされている
　

2. 対象のRPAのリリースキー（Release Key)を取得する

2-1: フォルダーID(OU ID)の取得

GET /odata/Folders によりフォルダーIDを取得する

（注）同種のAPIに GET /odata/OrganizationUnitsが存在するがオーケストレータのバージョンにより取得できないケースがある模様。また本APIは@deprecated

2-2: リリースキーの取得

GET /odata/Releases を(2-1)で取得したフォルダーIDと、実行するロボットの名称を指定してリリースキーを取得する

3. ジョブの登録

POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs を(2)で取得したリリースキー、ロボットが必要とするパラメータ情報、その他実行情報などとともに実行する
（登録されるとそのジョブを表すジョブID発行される）

4. ジョブの実行状況の監視

(3)で発行されたジョブIDを、GET /odata/Jobs(ジョブID)"で呼び出すことでジョブの処理状況を取得する

（注）ジョブIDはURLエンコードして設定する