API

API を使用すると、[パッケージを管理] メニューで提供されているサービスにアクセスして操作することができます。これらの API は、コード化されたオートメーションを設計する際に使用できます。コード化されたオートメーションと、API を使用してそれらのオートメーションを設計する方法について詳しくは、こちらをご覧ください。

注: [定義に移動] (F12) を使用すると、特定のサービスの UiPath API の定義にアクセスできます。コード化されたオートメーションを実装する場合は、直接公開されている API のみを使用することをお勧めします。サービスで直接公開されていないその他の API は、事前の通知なしに変更される場合があります。

オーバー ロード

API には多くの場合、過剰な負荷があります。つまり、パラメーター オプションが異なる同じメソッドの複数のバージョンを提供します。 オーバー ロードすると、特定の要件に基づいて API の動作をカスタマイズできます。 たとえば、UI Automation API には、UI 要素が表示されるまでの最大時間を指定するタイムアウト パラメーターを受け入れるオーバー ロードが設定されている場合があります。

API をそれぞれのオーバー ロードで使用することで、目的のオートメーションのロジックと動作を簡単に実現できます。

システム API

API	説明
データ行を追加	指定した DataTable に DataRow を追加します。
AddQueueItem	キューに新しいアイテムを追加します。
トランザクション アイテムを追加	キューに新しいアイテムを追加し、トランザクションを開始します。
文字列を追加書き込み	指定した文字列をファイルに追加し、ファイルが存在しない場合はファイルを作成します。
BulkAddQueueItems	複数アイテムのコレクションを指定した DataTable から Orchestrator のキューに追加します。
データ テーブルをクリア	指定された DataTable のすべてのデータをクリアします。
Zip ファイルを圧縮 (CompressZipFiles)	指定したファイルまたはフォルダーを圧縮 (zip) ファイル アーカイブに追加します。
ファイルをコピー	指定した場所から別の場所にファイルをコピーします。
ファイルを作成	指定した場所に空のファイルを作成します。その場所に既にファイルがある場合、
フォルダーを作成	指定した場所にディレクトリを作成します。
ファイルまたはフォルダーを削除	指定したファイルまたはフォルダーを削除します。
キュー アイテムを削除	指定した Orchestrator キューからステートが「新規」のアイテムを削除できます。
ストレージ ファイルを削除	Orchestrator で指定したストレージ バケットからファイルを削除します。
ストレージ ファイルをダウンロード	Orchestrator のストレージ バケット内のファイルのコピーをローカルにダウンロードします。
Unzip ファイルを抽出 (ExtractUnzipFiles)	zip ファイル アーカイブ内のすべてのコンテンツを指定したフォルダーに展開します。
データ テーブルをフィルター	フィルター ウィジェットで条件を指定してデータ テーブルをフィルター処理します。
アセットを取得	入力したアセット名を使用して、指定した Orchestrator アセットを取得します。
資格情報を取得	入力したアセット名を使用して、指定した資格情報アセットを取得します。
GetJobs	カスタム フィルターを指定して Orchestrator のジョブのリストを Orchestrator API で取得します。
Get Queue Item	このメソッドはアイテムを処理 (トランザクションを開始) できるようにキューからアイテムを取得し、そのステータスを [処理中] に設定します。
GetQueueItems	指定した Orchestrator キューから、作成日、優先度、ステート、参照などの複数のフィルターに従って、100 件までのトランザクションのリストを取得できます。
ローカル パスのリソースを取得	ファイルまたはフォルダーのローカル パスからリソースを構築します。
行項目を取得	指定した列に従ってデータ テーブルの行から値を取得します。
トランザクション アイテムを取得	処理ができるように Orchestrator のキューからアイテムを取得し (トランザクションを開始し)、そのステータスを進行中に設定します。
プロセスを呼び出し	ローカル マシンで使用可能な UiPath プロセスを実行します。
データ テーブルを結合	2 つの表の行を、[ JoinType ] パラメーターで指定された結合ルールに従って、これらの表に共通する値を使用して結合します。
ストレージ ファイルのリストを取得	Orchestrator の指定されたストレージ バケットから特定のパターンに一致するファイルのリストを取得します。
データ テーブルを検索	このメソッドは、Excel の式 VLOOKUP の動作をエミュレートします。指定したデータテーブル内の指定した値を検索できます。その値が見つかった行インデックスが返されます。
データ テーブルをマージ	貼り付け先とソースをマージし、変更を保存するかどうか、およびソースに存在しないスキーマをどのように処理するのかを指定します。
ファイルを移動	指定した場所から別の場所にファイルを移動します。
Orchestrator への HTTP 要求	実行中のロボットで認証することにより Orchestrator API に HTTP 要求を送信します。
OutputDataTable	CSV 形式を使用して DataTable を文字列に書き込みます。
パスの存在を確認	指定したパスが存在するかどうかをチェックします。パスとして、ファイル パスまたはディレクトリ パスを表現できます。
トランザクション アイテムを延期	Orchestrator のトランザクションを処理する必要のある期間を示す時間パラメーター ([延期] の日付以降かつ [処理期限] の日付以前) を追加します。
ストレージ テキストを読み込み	Orchestrator で指定したストレージ バケットからファイルをダウンロードして String 型変数に格納します。
テキスト ファイルを読み込み	指定したファイルからすべての文字を読み取り、String 型変数に格納します。
データ列を削除	指定した DataTable から DataColumn を削除します。
重複行を削除	指定した DataTable 変数から重複する行を削除し、最初に出現する行だけを維持します。
置換	指定した入力文字列において、正規表現のパターンと一致する文字列を指定した置換文字列に置換します。
アセットを設定	指定したアセットの値を更新できます。Orchestrator で使用可能なアセットであれば、グローバル アセットでもロボットごとのアセットでも構いません。
資格情報を設定	資格情報名で指定した名前の資格情報の値を更新できます。Orchestrator で使用可能なアセットであれば、グローバル アセットでもロボットごとのアセットでも構いません。
SetTransactionProgress	[処理中] の Orchestrator のトランザクションに対して、カスタムの進行状況ステータスを作成するのに役立ちます。
トランザクションのステータスを設定	Orchestrator のトランザクション アイテムのステータスを [失敗] または [成功] に設定します。
データ テーブルを並べ替え	指定した列の値に基づいて DataTable 全体を昇順または降順に並べ替えます。
StartJob	Orchestrator でジョブを開始できます。ジョブを実行するロボットの数を指定できます。
StopJob	Orchestrator でジョブを停止または強制終了できます。
行項目を更新	指定した値をデータ テーブル行の指定した列に割り当てます。
ストレージ ファイルをアップロード	Orchestrator で指定したストレージ バケットにファイルをアップロードします。
キュー アイテムを待機	指定されたキューから Orchestorator のキュー アイテムを取得し、QueueItem 型変数に格納します。
ストレージ テキストを書き込み	Orchestrator で指定したストレージ バケットに文字列をアップロードします。
テキスト ファイルに書き込み	指定したテキストをファイルに書き込みます。ファイルが既に存在する場合、既存のテキストは上書きされます。

API を使用する

対応するサービスから API を呼び出すには、 service.APIの形式を使用します。 たとえば、 system.GetAssetします。