Docusign - Get envelopeアクション
エンベロープ取得アクションは、Docusign内の単一のエンベロープの詳細を取得します。フィールドリファレンス全体については、Docusign Envelopes: get APIリファレンスを参照してください。
入力
| 入力フィールド | 説明 |
|---|---|
| エンベロープID | 取得するエンベロープのIDを入力します。 |
| 含める | 封筒に対して返す追加情報を選択します。利用可能なオプションについては、Include options を参照してください。受信者は自動的に含まれます。値を手動で入力する場合は、カンマ区切りのリストを使用します。例: tabs,powerform。 |
| 高度な更新 | 封筒情報の追加または変更を許可する場合に選択します。この入力によって、アクションが返すフィールドは変わりません。 |
Includeオプション
Include 入力フィールドは、アクションが封筒に対して返す追加情報を制御します。
| Include オプション | 説明 |
|---|---|
| カスタムフィールド | Custom fields フィールドを返します。 |
| ドキュメント | Envelope documents フィールドを返します。 |
| ドキュメントフィールド | それ自体では出力フィールドを追加しません。 Envelope documents フィールドを返すには、Documents を選択します。 |
| 添付ファイル | Envelope attachments フィールドを返します。 |
| 拡張機能 | Notification フィールドを返します。 |
| フォルダ | Folders フィールドを返します。 |
| 受信者 | Recipients フィールドを返します。このオプションは自動的に適用されます。 |
| PowerForm | Power forms フィールドを返します。 |
| 事前入力タブ | 各ドキュメントの事前入力タブを、その Tabs フィールドに含めた Envelope documents フィールドを返します。 |
| タブ | Recipients フィールド内の各受信者に対して、Tabs フィールドを返します。各タブに含まれるフィールドについては、Tab fields を参照してください。 |
| 支払いタブ | Payment tabs フィールドを返します。 |
| ワークフロー | Workflow フィールドを返します。 |
出力
| 出力フィールド | 説明 |
|---|---|
| エンベロープ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アドレス。 |
| メール本文 | すべての受信者に送信されるメールメッセージ本文。 |
| 初回送信日時 | エンベロープが最初に送信された日時。 |
| 有効期限日時 | エンベロープの有効期限が切れる日時。 |
| 無効化日時 | エンベロープが無効化された日時。 |
| エンベロープメタデータ | エンベロープの修正オプションおよび公証人オプションを説明するメタデータ。 |
| 高度な修正を許可（エンベロープメタデータ） | 高度な修正が許可されているかどうかを示します。 |
| 修正を許可（エンベロープメタデータ） | 修正が許可されているかどうかを示します。 |
| 公証人による署名を有効化（エンベロープメタデータ） | 公証人による署名が有効かどうかを示します。 |
| ウェット署名を有効化 | 署名者がドキュメントを印刷して紙に署名できるかどうかを示します。 |
| 再割り当てを許可 | 受信者がエンベロープをより適切な受信者にリダイレクトできるかどうかを示します。 |
| 21 CFR Part 11である | エンベロープが21 CFR Part 11（FDA電子記録）に準拠しているかどうかを示します。 |
| 署名者はモバイルで署名可能 | 署名者がモバイルデバイスで署名できるかどうかを示します。 |
| U sig状態 | Docusign用に予約されています。 |
| フォームデータが変更済み | エンベロープ内のフォームデータが変更されたかどうかを示します。 |
| 履歴の表示を許可 | 受信者がエンベロープの履歴を表示できるかどうかを示します。 |
| 動的エンベロープである | エンベロープが動的エンベロープであるかどうかを示します。 |
| デフォルトタブデータを書き込み | デフォルトタブデータがドキュメントに埋め込まれているかどうかを示します。 |
| 受信者 | エンベロープの受信者に関する情報。 |
| 現在のルーティング順序（受信者） | 現在処理されているルーティング順序。 |
| 受信者数（受信者） | エンベロープ上の受信者の合計数。 |
| 署名者（受信者） | ドキュメントに署名する必要がある受信者。 |
| 対面署名者（受信者） | 別のユーザーがホストして、対面で署名する受信者。 |
| 立会人（受信者） | 署名に立ち会う受信者。 |
| カーボンコピー（受信者） | 完了したドキュメントのコピーを受信するが、署名はしない受信者。 |
| 認証配信（受信者） | ドキュメントを受信する必要があるが、署名はしない受信者。 |
| エージェント（受信者） | 他の受信者の名前とメール情報を追加できる受信者。 |
| 編集者（受信者） | エンベロープの受信者とドキュメントを編集できる受信者。 |
| 仲介者（受信者） | ルーティング順序で自分の後に受信者を追加できる受信者。 |
| シール（受信者） | ドキュメントに適用される電子シール受信者。 |
| 公証人（受信者） | 公証人として機能する受信者。 |
| カスタムフィールド | 封筒上で定義されているカスタムフィールド。 Custom fields フィールドは、Include 入力フィールドで Custom fields を選択した場合にのみ使用できます。詳細については、カスタムフィールドを参照してください。 |
| エンベロープドキュメント | 封筒内のドキュメント。 Envelope documents フィールドは、Include 入力フィールドで Documents または Prefill tabs を選択した場合にのみ使用できます。詳細については、Envelope documents を参照してください。 |
| 封筒の添付ファイル | 封筒内の添付ファイル。 Envelope attachments フィールドは、Include 入力フィールドで Attachments を選択した場合にのみ使用できます。 |
| フォルダ | 封筒を含むフォルダ。 Folders フィールドは、Include 入力フィールドで Folders を選択した場合にのみ使用できます。詳細については、Folders を参照してください。 |
| Powerフォーム | 封筒に関連付けられている PowerForm。 Power forms フィールドは、Include 入力フィールドで PowerForm を選択した場合にのみ使用できます。 |
| 支払いタブ | 封筒内の支払いタブ。 Payment tabs フィールドは、Include 入力フィールドで Payment tabs を選択した場合にのみ使用できます。 |
| 通知 | 封筒のリマインダーおよび有効期限設定。 Notification フィールドは、Include 入力フィールドで Extensions を選択した場合にのみ使用できます。詳細については、Notification を参照してください。 |
| ワークフロー | 封筒で定義されているワークフローステップ。 Workflow フィールドは、Include 入力フィールドで Workflow を選択した場合にのみ使用できます。詳細については、Workflow を参照してください。 |
Recipientsフィールドは、受信者をタイプ別にグループ化します。上記の各タイプには、受信者フィールドで説明されているフィールドが含まれます。
カスタムフィールド
Custom fields フィールドには、封筒上で定義されているカスタムフィールドが含まれます。テキストカスタムフィールドとリストカスタムフィールドは、次のフィールドを共有します。リストカスタムフィールドには、リスト項目も含まれます。
| 出力フィールド | 説明 |
|---|---|
| Field ID | カスタムフィールドのID。 |
| 名前 | カスタムフィールドの名前。 |
| 表示する | カスタムフィールドがDocusign UIに表示されるかどうかを示します。 |
| 必須 | カスタムフィールドが必須かどうかを示します。 |
| 値 | カスタムフィールドの値。 |
| リスト項目（リストカスタムフィールド） | リストカスタムフィールドで使用可能な値。 |
封筒ドキュメント
Envelope documents フィールドには、封筒内のドキュメントが一覧表示されます。各ドキュメントには次のフィールドが含まれます。
| 出力フィールド | 説明 |
|---|---|
| ドキュメントID | ドキュメントのID。 |
| ドキュメントID GUID | ドキュメントのグローバル一意識別子 (GUID)。 |
| URI | ドキュメントを取得するためのURI。 |
| 名前 | ドキュメントの名前。 |
| タイプ | ドキュメントの種類。 |
| 順序 | 封筒内でドキュメントが表示される順序。 |
| ページ | ドキュメント内のページ。 |
| 表示 | ドキュメントが受信者に表示される方法。 |
| ダウンロードに含める | ドキュメントのダウンロード時にそのドキュメントが含まれるかどうかを示します。 |
| 署名者による確認必須 | 受信者がドキュメントをどのように確認する必要があるかを指定します。 |
| 正本 | ドキュメントがオーソリタティブコピーとしてマークされているかどうかを示します。 |
| テンプレートで必須 | テンプレートから封筒を作成する場合に、このドキュメントが必須かどうかを示します。 |
| タブ | ドキュメント上で定義されている事前入力タブ。 Tabs フィールドは、Include 入力フィールドで Prefill tabs を選択した場合にのみ使用できます。 |
フォルダ
Folders フィールドには、封筒を含むフォルダが一覧表示されます。各フォルダには次のフィールドが含まれます。
| 出力フィールド | 説明 |
|---|---|
| フォルダID | フォルダのID。 |
| 名前 | フォルダの名前。 |
| タイプ | フォルダのタイプ。 |
| URI | フォルダを取得するための URI。 |
| 所有者 | フォルダの所有ユーザーに関する情報。 |
通知
Notification フィールドには、封筒のリマインダーおよび有効期限設定が含まれます。封筒にこれらの設定がある場合にのみ、Docusign がこれらのフィールドを返します。
| 出力フィールド | 説明 |
|---|---|
| アカウントのデフォルトを使用 | 封筒がアカウントのデフォルトの通知設定を使用しているかどうかを示します。 |
| リマインダー | リマインダー設定。 |
| リマインダー有効（リマインダー） | リマインダーが有効になっているかどうかを示します。 |
| リマインダー遅延（リマインダー） | 最初のリマインダーが送信されるまでの日数。 |
| リマインダー頻度（リマインダー） | リマインダー間の日数。 |
| 有効期限 | 有効期限設定。 |
| 有効期限を有効化（有効期限） | エンベロープの有効期限が切れるかどうかを示します。 |
| 有効期限までの日数（有効期限） | エンベロープの有効期限が切れるまでの日数。 |
| 有効期限警告（有効期限） | 有効期限の何日前に警告が送信されるかを示す日数。 |
ワークフロー
Workflow フィールドには、封筒レベルのワークフローが含まれます。封筒にワークフローがある場合にのみ、Docusign がこのフィールドを返します。受信者の本人確認ワークフローは別個です。
| 出力フィールド | 説明 |
|---|---|
| ワークフローステータス | ワークフローのステータス。 |
| ワークフローステップ | ワークフロー内のステップ。 |
| アクション (Workflow steps) | ステップが実行するアクション。 |
| ステータス (Workflow steps) | ステップのステータス。 |
| トリガー対象アイテム (Workflow steps) | ステップをトリガーするアイテム。 |
| アイテム ID (Workflow steps) | ステップが適用されるアイテムの ID。 |
| 予定日 (Workflow steps) | ステップの実行が予定されている日時。 |
| 完了日 (Workflow steps) | ステップが完了した日時。 |
受信者フィールド
各受信者タイプ（署名者や立会人など）には、次のフィールドが含まれます。
| 出力フィールド | 説明 |
|---|---|
| Recipient ID | エンベロープ内の受信者のID。 |
| 受信者ID GUID | 受信者のグローバル一意識別子（GUID）。 |
| 受信者タイプ | 受信者のタイプ（例：署名者またはカーボンコピー）。 |
| メール | 受信者のメールアドレス。 |
| 名前 | 受信者の名前。 |
| Status | 受信者の現在のステータス。 |
| ロール名 | 受信者に割り当てられたロール。 |
| ルーティング順序 | 受信者がエンベロープを受信して操作する順序。 |
| ユーザーID | 受信者に関連付けられたDocusignユーザーのID。 |
| クライアントユーザーID | 埋め込み（キャプティブ）受信者に使用される識別子。 |
| 配信方法 | エンベロープを受信者に配信するために使用される方法。 |
| メモ | 受信者に表示されるプライベートメモ。 |
| 送信日時 | エンベロープが受信者に送信された日時。 |
| 配信日時 | 受信者がエンベロープを表示した日時。 |
| 署名日時 | 受信者が署名した日時。 |
| 完了日時 | 受信者が自分のアクションを完了した日時。 |
| ID検索を要求 | 受信者がID検索を通じて確認される必要があるかどうかを示します。 |
| 一括受信者である | 受信者が一括送信の一部であるかどうかを示します。署名者にのみ適用されます。 |
| 受信者がタブを提供 | 受信者が自分のタブを提供するかどうかを示します。署名者にのみ適用されます。 |
| 署名のアップロードを要求 | 受信者が署名をアップロードする必要があるかどうかを示します。署名者にのみ適用されます。 |
| 完了回数 | 受信者が署名を完了した回数。 |
| タブ合計数 | 受信者に割り当てられたタブの合計数。 |
| 作成理由 | 受信者がエンベロープに追加された理由。 |
| タブ | 受信者に割り当てられたタブ（タイプ別にグループ化）。 Tabs フィールドは、Include 入力フィールドで Tabs を選択した場合にのみ使用できます。詳細については、タブフィールドを参照してください。 |
タブフィールド
Tabsフィールドは、受信者のタブをタイプ別にグループ化します。各タブには、タイプに関係なく次のフィールドが含まれます。
タブタイプには次のものがあります：
- ここに署名タブ
- ここにイニシャルタブ
- 署名日タブ
- フルネームタブ
- 名タブ
- 姓タブ
- メールアドレスタブ
- 役職タブ
- 会社タブ
- メールタブ
- SSNタブ
- ZIPタブ
- テキストタブ
- 数値タブ
- 日付タブ
- チェックボックスタブ
- リストタブ
- ラジオグループタブ
- メモタブ
| 出力フィールド | 説明 |
|---|---|
| タブID | タブの一意の識別子。 |
| タブラベル | タブに割り当てられたラベル。 |
| 名前 | タブの名前。 |
| タブタイプ | タブのタイプ。 |
| ドキュメントID | タブが表示されるドキュメントのID。 |
| Recipient ID | タブが割り当てられている受信者のID。 |
| ページ番号 | タブが表示されるページ番号。 |
| X位置 | ページ上のタブの水平位置（ピクセル単位）。 |
| Y位置 | ページ上のタブの垂直位置（ピクセル単位）。 |
| Status | タブの現在のステータス。 |
| ロック済み | タブが編集できないようにロックされているかどうかを示します。 |
| アンカー文字列 | タブがアンカーされるテキスト文字列。 |
| アンカーXオフセット | アンカー文字列からの水平オフセット（ピクセル単位）。 |
| アンカーYオフセット | アンカー文字列からの垂直オフセット（ピクセル単位）。 |
| 値 | タブに入力または選択された値。 |
| 必須 | 受信者がタブを完了する必要があるかどうかを示します。 |
最終更新日: