ドキュメントのリストを表示

UiPath.DocuSign.Activities.EnvelopeList.ListDocuments

[ドキュメントのリストを取得] アクティビティでは、DocuSign の eSignature API を使用して、エンベロープ内のドキュメントのリストを取得します。

このアクティビティで使用できる任意のフィルターがいくつかあります。これは、返される項目のリストに影響を与えるために使用できます。

動作のしくみ

以下の手順は、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 「セットアップ」の手順を完了します。
2. プロジェクトに [ DocuSign スコープ ] アクティビティを追加します。
3. [DocuSign スコープ] アクティビティ内に [ドキュメントのリストを取得] アクティビティを追加します。
4. アクティビティの本体内にあるプロパティの値を入力します。
5. [出力] セクションのプロパティのために ResponseStatus 型変数を作成し、入力します。

アクティビティの本体

• アカウント ID - エンベロープを作成するアカウント ID です。このフィールドでは、 Strings 変数または String 変数のみがサポートされています。これは、アカウント番号 (int) またはアカウント ID (GUID) のいずれかです。
• エンベロープ ID - エンベロープ ID です。このフィールドでは、 Strings 変数または String 変数のみがサポートされています。
• ユーザー ID によるドキュメント - true の場合、受信者はユーザー ID でドキュメントを取得できます。このフィールドでは Boolean 変数のみがサポートされています。たとえば、ユーザーが表示の異なる 2 つの異なるルーティング オーダーに含まれている場合、このパラメーターを使用すると、両方のルーティング オーダーのすべてのドキュメントが返されます。
• ドキュメント サイズを含める - ドキュメント サイズを含めるかどうかを指定します。このフィールドでは Boolean 変数のみがサポートされています。
• メタデータを含める - メタデータを含めるかどうかを指定します。このフィールドでは Boolean 変数のみがサポートされています。true の場合、送信者が編集できるプロパティを示すメタデータが含まれます。
• タブを含める - タブを含めるかどうかを指定します。このフィールドでは Boolean 変数のみがサポートされています。true の場合、ドキュメントに関連付けられたタブに関する情報が含まれます
• 受信者 ID - 送信者が制御する受信者の 1 人としてドキュメントを取得できます。String変数を入力します。そのためには、(Documents by UserId) パラメーターを false に設定する必要があります。
• 共有ユーザー ID - ドキュメントのリストの表示を取得するために偽装する共有ユーザーの ID です。このフィールドでは String 変数のみがサポートされています。このパラメータは、共有受信トレイのコンテキストで使用されます(つまり、RADminコンソールを介してあるユーザーから別のユーザーにエンベロープを共有する場合)。
• エンベロープ ドキュメントの結果 - エンベロープに含まれるドキュメントです。このフィールドでは EnvelopeDocumentsResult 変数のみがサポートされています。

プロパティ

共通

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

その他

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

出力

• 応答ステータス - 要求のステータスです (成功/失敗に関する情報)。このフィールドでは ResponseStatus 変数のみをサポートします。