API

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

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

オーバー ロード

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

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

テスト用 API

注: API では macOS および Linux オペレーティング システムでのスクリーンショットの作成はサポートされないことを確認してください。

API	説明
Address	指定したランダムな国と市区町村に基づいて、有効な住所を生成します。
AddTestDataQueueItem	指定したテスト データのキューにデータ行を追加します。
AttachDocument	結果を証明するためにテストの実行結果にドキュメントを添付します。
BulkAddTestDataQueueItems	指定されたテスト データ キューにデータ テーブルを追加します。
DeleteTestDataQueueItems	指定したテスト データのキュー アイテムを削除します。
GetTestDataQueueItem	指定したテスト データのキューから 1 つのデータ行を抽出します。
GetTestDataQueueItems	指定したテスト データのキューから複数のデータ行を抽出します。
GivenName	ランダムな名の名を生成します。
LastName	ランダムな姓を生成します。
RandomDate	2 つの日付の間でランダムな日付を生成します。
RandomNumber	指定した長さのランダムな整数を生成します。
RandomString	長さと大文字/小文字を指定して、ランダムな文字列を生成します。
RandomValue	1 列のリストから 0 ~ 20 億の範囲内のランダムな行を選択します。
VerifyAreEqual	2 つの式が等しいかどうかを検証します。
VerifyAreNotEqual	2 つの式が等しくないかどうかを検証します。
VerifyContains	最初の式に 2 番目の式が含まれているかどうかを検証します。
ドキュメントの等価性を検証	Verifies if two documents are equivalent using multiple comparison options.
VerifyExpression	指定された式の真理値を検証します。
VerifyExpressionWithOperator	演算子を使用して、指定した式と比較してアサートすることにより、式を検証します。
VerifyIsGreater	最初の式が 2 番目の式より大きいことを検証します。
VerifyIsGreaterOrEqual	最初の式が 2 番目の式より大きいことを検証します。
VerifyIsLess	最初の式が 2 番目の式より小さいかどうかを検証します。
VerifyIsLessOrEqual	最初の式が 2 番目の式以下かどうかを検証します。
VerifyIsRegexMatch	最初の式が 2 番目の式の正規表現の一致するかどうかを検証します。
VerifyRange	式が指定した範囲内にあるかどうかを検証します。
VerifyTextEquivalence	Verifies if two texts are equivalent using multiple comparison options.

API を使用する

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