レコードを検索

UiPath.MicrosoftDynamics.Activities.SearchRecords

[レコードを検索] アクティビティは、検索パラメーター ([クエリ オプション] と [オブジェクト]) に基づき、Web API の GET 操作を使用してレコードを取得します。

レコードの取得後、アクティビティは結果を DataTable オブジェクト (Result) に、要求のステータス (成功/失敗に関する情報) を ResponseStatus オブジェクト (MicrosoftDynamicsStatus) に出力します。いずれのオブジェクトも、後続のアクティビティ (例: 条件ロジック、[レコードを更新]、[活動の添付ファイルをダウンロード] など) で使用できます。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [Microsoft Dynamics アプリケーション スコープ] アクティビティを追加します。
3. [ Microsoft Dynamics アプリケーション スコープ] アクティビティ内に [ レコードを検索 ] アクティビティを追加します。
4. 取得するオブジェクトを選択し、[オプション] プロパティに検索パラメーターを入力します。
5. [出力] プロパティの DataTable 変数および ResponseStatus 変数を作成し、入力します。
   • 入力プロパティ値は、GET 操作の要求に渡されます。
   • 操作は、DataTable と ResponseStatus の値を、出力プロパティ変数に返します。
     
     

     

     
     

アクティビティの本体

• オブジェクト - オブジェクト ウィザードを使用してオブジェクトを選択します。

プロパティ

共通

• 表示名 - アクティビティの表示名です。 このフィールドは、文字列または String 型変数のみをサポートします。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

オプション

• クエリ オプション - レコードの取得に使用する検索パラメーターです。Dictionary<String, String> または Dictionary<String, String> 型変数を入力します。クエリ値に関する詳細は、Microsoft ドキュメントのクエリ メタデータおよびクエリ データのページをご覧ください。Dictionary<String, String> 変数を作成および設定する方法の 1 つとして、下記の手順をご覧ください。
  注:

  以下は、Dictionary<String, String> 変数を設定する 1 つの方法です。

  • Microsoft.Activities.Extensions パッケージをインストールします。
  • 新しい Dictionary<String, String> 変数を作成します (例: queryOption)。
  • [ Add to Dictionary] アクティビティを 追加します。
  • Dictionary 変数を入力します (例: queryOption)。
  • [キー] プロパティに、単一クエリ メソッド (例: "$filter"、"$select" など) を入力します。

  • クエリ メソッドに適用する [値] を入力します (例: "name eq 'Quickstart_Account'")。

    • その他にも [クエリ オプション] を適用するには、手順 3 を繰り返します。

出力

• 応答ステータス - 要求のステータスです (成功/失敗に関する情報)。 ResponseStatus 型変数を入力します (UiPath.BAF.Models.ResponseStatus)。 ResponseStatus オブジェクトには、他のアクティビティで使用できる 3 つのプロパティが含まれています。
  • Success - Boolean - API 要求が成功したかどうかを示します。
  • ErrorCode - String - API 要求が成功しなかった場合の応答エラーです (Success=False)。
  • Message - String - エラー メッセージです。
• 結果 - 検索パラメーターに一致したレコードです。DataTable 型変数を入力します。

例

次の画像は、アクティビティの依存関係と入力/出力プロパティの値の例です。

ステップバイステップの手順および例は、クイックスタート ガイドをご覧ください。