Docusign - List envelopes (batch)アクション
List envelopes (batch)アクションは、指定した条件に一致するエンベロープのバッチを取得します。 詳細については、Docusign Envelopes: listStatusChanges APIリファレンスを参照してください。
入力
| 入力フィールド | 説明 |
|---|---|
| 開始日 | この日付以降にステータスが変更されたエンベロープを返します。 |
| 終了日 | この日付までにステータスが変更されたエンベロープを返します。 デフォルトは現在時刻です。 |
| 開始/終了ステータス | 日付範囲の適用先となるステータスタイプを指定します。 デフォルトはChangedです。 有効な値はChanged、Voided、Created、Deleted、Sent、Delivered、Signed、Completed、Declined、Timed out、およびProcessingです。 |
| Status | ステータスでエンベロープをフィルターします。 有効な値はChanged、Voided、Created、Deleted、Sent、Delivered、Signed、Completed、Declined、Timed out、およびProcessingです。 |
| エンベロープID | 結果をフィルターするには、エンベロープIDのカンマ区切りリストを入力します。 |
| メール | 送信者または受信者のメールアドレスでエンベロープをフィルターします。 |
| 並べ替え基準 | このフィールドでエンベロープを並べ替えます。 有効な値はAction required、Created、Completed、Envelope name、Expire、Last modified、Sent、Signer list、Status、Status changed、Subject、およびUser nameです。 |
| 順序 | 並べ替え順序の方向を設定します。 有効な値はAscendingおよびDescendingです。 |
| 検索テキスト | 件名行、または受信者の名前とメールアドレスに含まれるテキストでエンベロープをフィルターします。 |
| トランザクションID | 結果をフィルターするには、トランザクションIDのカンマ区切りリストを入力します。 |
| ユーザーフィルター | ユーザーとの関係に基づいてエンベロープをフィルターします。 |
| ユーザーID | 関連付けられたユーザーのIDでエンベロープをフィルターします。 |
| ユーザー名 | 関連付けられたユーザーの名前でエンベロープをフィルターします。 |
| 件数 | ページごとに返すエンベロープの最大数を指定します。 |
| 開始位置 | 結果の返却を開始する結果のゼロベースインデックスを指定します。 |
出力
| 出力フィールド | 説明 |
|---|---|
| 結果セットサイズ | 現在のバッチで返された結果の数。 |
| 合計セットサイズ | 利用可能な結果の合計数。 |
| 開始位置 | バッチ内の最初の結果のゼロベースインデックス。 |
| 終了位置 | バッチ内の最後の結果のゼロベースインデックス。 |
| 次のURI | 次の結果バッチを取得するためのURI。 |
| 前のURI | 前の結果バッチを取得するためのURI。 |
| エンベロープ | 指定した条件に一致するエンベロープ。 エンベロープを参照してください。 |
エンベロープ
バッチ内の各エンベロープには、次の概要フィールドが含まれます。 これは、Get envelopeアクションで返されるフィールドのサブセットです。
| 出力フィールド | 説明 |
|---|---|
| エンベロープID | ドキュメントのライフサイクルを追跡および管理するためにエンベロープに割り当てられたID。 |
| Status | エンベロープの現在のステータス。 |
| メール件名 | すべての受信者に送信されるメールの件名行。 |
| 署名場所 | 署名が行われる物理的な場所。 有効な値はInPersonおよびOnlineです。 デフォルト値はOnlineです。 |
| パージ状態 | エンベロープのドキュメントの現在のパージ状態。 |
| エンベロープの場所 | Docusign用に予約されています。 |
| 任意の署名者 | 非推奨です。 この機能は署名グループに置き換えられました。 |
| 無効化の理由 | エンベロープが無効化された理由。 |
| 有効期限の有効化 | 設定された日数の経過後にエンベロープが期限切れになるよう設定されているかどうかを示します。 |
| 有効期限までの日数 | エンベロープの有効期限が切れるまでの日数。 |
| マークアップを許可 | Document Markup機能が有効かどうかを示します。 |
| エンベロープIDのスタンプ | エンベロープIDがドキュメントにスタンプされるかどうかを示します。 |
| 自動ナビゲーション | 受信者に自動ナビゲーションが設定されているかどうかを示します。 |
| 署名プロバイダーエンベロープである | エンベロープがサードパーティの署名プロバイダーを使用しているかどうかを示します。 |
| チケット関連エンベロープかどうか | エンベロープがサポートチケットに関連付けられているかどうかを示します。 |
| 作成日時 | エンベロープが作成された日時。 |
| 送信日時 | エンベロープが送信された日時。 |
| 配信日時 | エンベロープが受信者に配信された日時。 |
| 完了日時 | エンベロープが完了した日時。 |
| 最終変更日時 | エンベロープが最後に変更された日時。 |
| ステータス変更日時 | エンベロープのステータスが最後に変更された日時。 |
| エンベロープURI | エンベロープを取得するためのURI。 |
| ドキュメントURI | エンベロープのドキュメントを取得するためのURI。 |
| 受信者URI | エンベロープの受信者を取得するためのURI。 |
| 添付ファイルURI | エンベロープの添付ファイルを取得するためのURI。 |
| カスタムフィールドURI | エンベロープのカスタムフィールドを取得するためのURI。 |
| 通知URI | エンベロープの通知設定を取得するためのURI。 |
| テンプレートURI | エンベロープのテンプレートを取得するためのURI。 |
| 証明書URI | エンベロープの完了証明書を取得するためのURI。 |
| 結合済みドキュメントURI | すべてのドキュメントを1つのPDFに結合して取得するためのURI。 |
| 送信者 | エンベロープを送信したユーザーに関する情報。 |
| ユーザーID（送信者） | エンベロープを送信したユーザーのID。 |
| ユーザー名（送信者） | エンベロープを送信したユーザーの名前。 |
| メール（送信者） | エンベロープを送信したユーザーのメールアドレス。 |
| アカウントID（送信者） | エンベロープを送信したアカウントのID。 |
| IPアドレス（送信者） | エンベロープを送信したユーザーのIPアドレス。 |
最終更新日: