RobotAPI

UiPath Robot API は、ユーザー独自のロボットの機能を拡張するために設計されたコンポーネントです。Robot API はさまざまな機能を備えており、各機能はオートメーションの管理の特定の側面に対応します。たとえば、次のような機能があります。

• 個々のジョブの管理: 個人オートメーション プロセスを実行、停止、追跡する機能を提供します。
• ドメイン固有のインターフェイス: 固有の自動化ニーズに合わせてカスタマイズされたインターフェイスを開発できます。
• ローカルでのアクセス性: ロボットがインストールされているマシンでのみ利用可能なので、セキュリティで保護された直接アクセスが保証されます。
• バージョンの互換性: インストールされた Robot のバージョンとの一貫性を維持し、後方互換性を確保できます。

Robot API は UiPath.Robot.api ライブラリを使用します。ライブラリをダウンロードするには、次のフィードを使用します。

https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json.

相互運用性マトリクス

Robot のバージョン	API 2024.10.x	API 2023.10.x	API 2023.4.x	API 2022.10.x	API 2022.4.x	API 2021.10.x
Robot 2024.10.x	✅	✅	✅	✅	✅	✅
Robot 2023.10.x	❌	✅	✅	✅	✅	✅
Robot 2023.4.x	❌	❌	✅	✅	✅	✅
Robot 2022.10.x	❌	❌	❌	✅	✅	✅
Robot 2022.4.x	❌	❌	❌	❌	✅	✅
Robot 2021.10.x	❌	❌	❌	❌	❌	✅

一般的な Robot API 呼び出し

• クライアントをアプリケーションに含める

  var client = new RobotClient();
  

• 利用可能なプロセス リストを取得する

  var processes = await client.GetProcesses();
  var myProcess = processes.Single(process => process.Name == "MyProcess");
  var job = myProcess.ToJob();
  

• プロセス キーを使用してジョブを開始する

  var job = new Job("812e908a-7609-4b81-86db-73e3c1438be4");
  

• プロセス実行を開始する

  {
    await client.RunJob(job);
  }  
    catch (Exception ex)
  {  
    Console.WriteLine(ex.ToString());
  }
  

• 入力引数を追加する

  job.InputArguments = {["numbers"] = new int[] { 1, 2, 3 }};
  await client.RunJob(job);
  

• 出力引数をエクスポートする

  var jobOutput = await client.RunJob(job);
  Console.WriteLine(jobOutput.Arguments["sumOfNumbers"]);
  

• プロセスを停止する

  await client.RunJob(job, cancellationToken);
  

• プロセスのステータスを監視する

  job.StatusChanged += (sender, args) => Console.WriteLine($"{((Job)sender).ProcessKey}: {args.Status}");
  await client.RunJob(job);
  

• イベント スケジューラーを使用する

  new RobotClient(new RobotClientSettings { EventScheduler = TaskScheduler.Default })