［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)の取得

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

（注）同種のAPIに

GET /odata/OrganizationUnits

が存在するがオーケストレータのバージョンにより取得できないケースがある模様。また本APIは

@deprecated

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

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

3. ジョブの登録

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

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

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

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

※転載元の情報は上記執筆時点の情報です。

上記執筆後に転載元の情報が修正されることがあります。

執筆者のページはこちら