Docusign - テンプレートを取得アクション
テンプレートを取得アクションは、Docusignの単一のテンプレートの詳細を取得します。フィールドの完全なリファレンスについては、Docusign Templates: get APIリファレンスを参照してください。
入力
| 入力フィールド | 説明 |
|---|---|
| Template | 取得するテンプレートを選択します。 |
| 含める | テンプレートに対して返す追加情報を選択します。利用可能なオプションについては、Include options を参照してください。ドキュメントは常に自動的に含まれます。値を手動で入力する場合は、カンマ区切りのリストを使用します。たとえば、powerforms,favorite_template_status。 |
Includeオプション
Include 入力フィールドは、テンプレートに対してアクションが返す追加情報を制御します。
| Include オプション | 説明 |
|---|---|
| PowerForms | Power forms フィールドを返します。 |
| タブ | Recipients フィールド内の各受信者に対して、Tabs フィールドを返します。各タブに含まれるフィールドについては、Tab fields を参照してください。 |
| ドキュメント | Documents フィールドを返します。このオプションは常に自動的に適用されます。 |
| お気に入りテンプレートステータス | Favorited by me フィールドを返します。 |
出力
| 出力フィールド | 説明 |
|---|---|
| Template ID | templateの一意識別子。 |
| 名前 | テンプレートの名前。 |
| 説明 | テンプレートの説明。 |
| Status | テンプレートの現在のステータス。 |
| メール件名 | すべての受信者に送信されるメールの件名行。 |
| メール本文 | すべての受信者に送信されるメールメッセージ本文。 |
| 署名場所 | 署名が行われる物理的な場所。有効な値はInPersonおよびOnlineです。デフォルト値はOnlineです。 |
| ページ数 | テンプレート内のドキュメントページ数。 |
| 共有済み | テンプレートが他のユーザーと共有されているかどうかを示します。 |
| パスワード保護済み | テンプレートがパスワードで保護されているかどうかを示します。 |
| 正本 | ドキュメントが正本としてマークされているかどうかを示します。 |
| 署名者の表示を適用 | エンベロープに対してドキュメントの表示設定が適用されるかどうかを示します。 |
| ウェット署名を有効化 | 署名者がドキュメントを印刷して紙に署名できるかどうかを示します。 |
| マークアップを許可 | Document Markup機能が有効かどうかを示します。 |
| 再割り当てを許可 | 受信者がエンベロープをより適切な受信者にリダイレクトできるかどうかを示します。 |
| レスポンシブドキュメントを無効化 | レスポンシブドキュメントが無効になっているかどうかを示します。 |
| 自動照合 | テンプレートが自動照合に含まれているかどうかを示します。 |
| ユーザーによる自動照合の指定 | テンプレートが自動照合に明示的に含められているか、または除外されているかどうかを示します。 |
| 任意の署名者 | 非推奨です。この機能は署名グループに置き換えられました。 |
| エンベロープの場所 | Docusign用に予約されています。 |
| フォルダID | テンプレートを含むフォルダのID。 |
| フォルダ名 | テンプレートを含むフォルダの名前。 |
| フォルダID | テンプレートが直接またはテンプレート共有を通じて存在するフォルダのID。 |
| 値(フォルダID) | フォルダID。 |
| URI | テンプレートを取得するためのURI。 |
| 作成日時 | テンプレートが作成された日時。 |
| 最終更新日時 | テンプレートが最後に変更された日時。 |
| 最終使用日時 | テンプレートが最後に使用された日時。 |
| 所有者 | テンプレートを所有するユーザーに関する情報。 |
| ユーザーID(所有者) | テンプレートを所有するユーザーのID。 |
| ユーザー名(所有者) | テンプレートを所有するユーザーの名前。 |
| メール(所有者) | テンプレートを所有するユーザーのメールアドレス。 |
| アカウントID(所有者) | テンプレートを所有するアカウントのID。 |
| 最終更新者 | テンプレートを最後に変更したユーザーに関する情報。 |
| ユーザー名(最終変更者) | テンプレートを最後に変更したユーザーの名前。 |
| ユーザーID(最終変更者) | テンプレートを最後に変更したユーザーのID。 |
| メール(最終変更者) | テンプレートを最後に変更したユーザーのメールアドレス。 |
| URI(最終変更者) | テンプレートを最後に変更したユーザーを取得するためのURI。 |
| ドキュメント | テンプレート内のドキュメント。ドキュメントを参照してください。 |
| 通知 | テンプレートのリマインダーおよび有効期限設定。通知を参照してください。 |
| カスタムフィールド | テンプレートで定義されたカスタムフィールド。カスタムフィールドを参照してください。 |
| エンベロープIDのスタンプ | エンベロープIDがドキュメントにスタンプされるかどうかを示します。 |
| 自動ナビゲーション | 受信者に自動ナビゲーションが設定されているかどうかを示します。 |
| U sig状態 | Docusign用に予約されています。 |
| 受信者 | テンプレートで定義された受信者。受信者を参照してください。 |
| 受信者ロール | テンプレートで定義された受信者ロール。 |
| ロール名(受信者ロール) | ロールの名前。 |
| 受信者タイプ(受信者ロール) | ロールの受信者タイプ。 |
| 事前入力タブ | テンプレートで定義された事前入力タブ。タブフィールドを参照してください。 |
| Powerフォーム | テンプレートから作成された PowerForms。 Power forms フィールドは、Include 入力フィールドで PowerForms を選択した場合にのみ使用できます。 Power forms を参照してください。 |
| 自分がお気に入りに追加 | 接続ユーザーがテンプレートをお気に入りとしてマークしているかどうかを示します。 Favorited by me フィールドは、Include 入力フィールドで Favorite template status を選択した場合にのみ使用できます。 |
ドキュメント
ドキュメントフィールドには、テンプレートに含まれるドキュメントが一覧表示されます。各ドキュメントには次のフィールドが含まれます。
| 出力フィールド | 説明 |
|---|---|
| ドキュメントID | ドキュメントのID。 |
| URI | ドキュメントを取得するためのURI。 |
| 名前 | ドキュメントの名前。 |
| 順序 | テンプレート内でドキュメントが表示される順序。 |
| ページ | ドキュメント内のページ数。 |
| 表示 | ドキュメントが受信者に表示される方法。 |
| ダウンロードに含める | ドキュメントのダウンロード時にそのドキュメントが含まれるかどうかを示します。 |
| 署名者による確認必須 | 受信者がドキュメントをどのように確認する必要があるかを指定します。 |
| テンプレートでロック済み | ドキュメントがテンプレート内でロックされているかどうかを示します。 |
| テンプレートで必須 | ドキュメントがテンプレート内で必須かどうかを示します。 |
| タブ | ドキュメントで定義されたタブ。タイプ別にグループ化されます。詳細については、タブフィールドを参照してください。 |
通知
通知フィールドには、テンプレートから作成されたエンベロープに適用されるリマインダーおよび有効期限設定が含まれます。
| 出力フィールド | 説明 |
|---|---|
| リマインダー | リマインダー設定。 |
| リマインダー有効(リマインダー) | リマインダーが有効になっているかどうかを示します。 |
| リマインダー遅延(リマインダー) | 最初のリマインダーが送信されるまでの日数。 |
| リマインダー頻度(リマインダー) | リマインダー間の日数。 |
| 有効期限 | 有効期限設定。 |
| 有効期限を有効化(有効期限) | エンベロープの有効期限が切れるかどうかを示します。 |
| 有効期限までの日数(有効期限) | エンベロープの有効期限が切れるまでの日数。 |
| 有効期限警告(有効期限) | 有効期限の何日前に警告が送信されるかを示す日数。 |
カスタムフィールド
カスタムフィールドフィールドには、テンプレートで定義されたカスタムフィールドが含まれます。テキストカスタムフィールドとリストカスタムフィールドは、次のフィールドを共有します。リストカスタムフィールドには、リスト項目も含まれます。
| 出力フィールド | 説明 |
|---|---|
| Field ID | カスタムフィールドのID。 |
| 名前 | カスタムフィールドの名前。 |
| 表示する | カスタムフィールドがDocusign UIに表示されるかどうかを示します。 |
| 必須 | カスタムフィールドが必須かどうかを示します。 |
| 値 | カスタムフィールドの値。 |
| リスト項目(リストカスタムフィールド) | リストカスタムフィールドで使用可能な値。 |
Power forms
Power forms フィールドには、テンプレートから作成された PowerForms が一覧表示されます。各 PowerForm には次のフィールドが含まれます。
| 出力フィールド | 説明 |
|---|---|
| Power form ID | PowerForm の ID。 |
| 名前 | PowerForm の名前。 |
| URI | PowerForm を取得するための URI。 |
| PowerForm URL | 受信者が PowerForm から署名を開始するために使用する URL。 |
| 送信者名 | 送信者の名前。 |
| 送信者ユーザーID | 送信者の ID。 |
| Template ID | PowerForm が使用するテンプレートの ID。 |
| テンプレート名 | PowerForm が使用するテンプレートの名前。 |
| メール件名 | 受信者に送信されるメールの件名。 |
| メール本文 | 受信者に送信されるメール本文。 |
| 指示 | 受信者に表示される手順。 |
| 署名モード | PowerForm の署名モード。 |
| 有効 | PowerForm が有効かどうかを示します。 |
| 使用制限間隔有効 | PowerForm の使用回数が、ある期間内でどの程度の頻度までに制限されているかどうかを示します。 |
| 使用制限間隔の単位 | 使用間隔の時間の単位。 |
| 最大使用数有効 | PowerForm の総使用回数に上限があるかどうかを示します。 |
| 使用回数 | PowerForm が使用された回数。 |
| 作成日時 | PowerForm が作成された日時。 |
| 最終使用日時 | PowerForm が最後に使用された日時。 |
受信者
受信者フィールドは、署名者、対面署名者、証人など、タイプ別に受信者をグループ化します。これはエンベロープを取得アクションで使用される構造と同じです。各受信者に含まれるフィールドについては、受信者フィールドを参照してください。
タブフィールド
事前入力タブを使用すると、送信者は読み取り専用の値をテンプレートに追加できます。これらはテンプレートレベルおよび各ドキュメントのタブの下に表示され、タイプ別にグループ化されます: テキストタブ、数値タブ、日付タブ、チェックボックスタブ、ラジオグループタブ。各事前入力タブには次のフィールドが含まれます。
| 出力フィールド | 説明 |
|---|---|
| タブID | タブの一意の識別子。 |
| タブラベル | タブに割り当てられたラベル。 |
| タブタイプ | タブのタイプ。 |
| ドキュメントID | タブが表示されるドキュメントのID。 |
| ページ番号 | タブが表示されるページ番号。 |
| 必須 | 受信者がタブを完了する必要があるかどうかを示します。 |
| 検証パターン | タブの値を検証するために使用される正規表現。 |
| 検証メッセージ | タブの値が検証に失敗したときに表示されるメッセージ。 |
| 最大長 | タブで許可される最大文字数。 |
| 選択済み | タブが選択されているかどうかを示します。 |
| ラジオボタン | ラジオグループタブ内のラジオボタン。 |
| グループ名 | タブが属するグループの名前。 |
ドキュメントタブは、タブグループに整理することもできます。各タブグループには、タブID、タブタイプ、グループラベル、グループルール、ページ番号、およびステータスがあります。
最終更新日: