製品アップデートステータスページWorkato Academy
English
日本語
無料で開始
コネクター
アプリコネクター
Docusign
アクション

Docusign - List envelopes (batch)アクション ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

エンベロープのリスト（バッチ）アクションは、Docusignで指定した条件に一致するエンベロープのバッチを取得します。詳細については、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でエンベロープをフィルターします。
ユーザー名関連付けられたユーザーの名前でエンベロープをフィルターします。
件数ページごとに返すエンベロープの最大数を指定します。
開始位置結果の返却を開始する結果のゼロベースインデックスを指定します。
含める各封筒について返す追加情報を選択します。利用可能なオプションについては、Additional envelope output を参照してください。このフィールドを空のままにした場合、サマリーフィールドのみが返されます。値を手動で入力する場合は、カンマ区切りのリストを使用します。例: custom_fields,documents。

出力 ​

出力フィールド説明
結果セットサイズ現在のバッチで返された結果の数。
合計セットサイズ利用可能な結果の合計数。
開始位置バッチ内の最初の結果のゼロベースインデックス。
終了位置バッチ内の最後の結果のゼロベースインデックス。
次のURI次の結果バッチを取得するためのURI。
前のURI前の結果バッチを取得するためのURI。
エンベロープ指定した条件に一致するエンベロープ。エンベロープを参照してください。

エンベロープ ​

バッチ内の各エンベロープには、次の概要フィールドが含まれます。これは、Get envelopeアクションで返されるフィールドのサブセットです。各封筒の詳細情報を返すには、Include 入力フィールドを使用できます。詳細については、Additional envelope output を参照してください。

出力フィールド説明
エンベロープ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アドレス。

追加の封筒出力 ​

Include 入力フィールドで選択した各オプションに対して、出力内の各封筒にオブジェクトが追加されます。出力には、選択したオプションに対応するオブジェクトのみが含まれます。これにより、各封筒ごとに個別のアクション呼び出しを行う代わりに、単一の呼び出しで関連する封筒データを取得できます。

Include オプション追加される出力フィールド説明
カスタムフィールドカスタムフィールド封筒上のカスタムフィールド。 Text custom fields と List custom fields が含まれます。
ドキュメントエンベロープドキュメント封筒内のドキュメント。各ドキュメントのページを含みます。
添付ファイル封筒の添付ファイル封筒上の添付ファイル。各添付ファイルのID、種類、名前、ラベル、リモートURL、およびアクセス制御を含みます。
拡張機能通知封筒のリマインダーと有効期限の設定。 Use account defaults、Reminders、Expirations が含まれます。
フォルダフォルダ封筒を含むフォルダ。各フォルダのID、名前、種類、URI、および親フォルダを含みます。
受信者受信者受信者タイプごとにグループ化された、封筒の受信者。各タイプのフィールドについては、Get envelope アクションの Recipient fields を参照してください。
支払いタブ支払いタブ封筒上の支払いタブ。各タブのID、受信者ID、ドキュメントID、ページ番号、金額、通貨コードを含みます。

最終更新日: