Adobe Acrobat Sign Government
Adobe は、世界で最も信頼されているデジタル ドキュメント署名サービスです。 Adobe Acrobat Sign を使用して、手動のプロセスをすべてデジタル エクスペリエンスに変換することができます。 Adobe Acrobat Sign 機能をお使いのアプリケーションに組み込んで、契約のステータスの作成、送信、および監視を行います。
このコネクタは、次の製品および地域で利用可能です:
| サービス | クラス | リージョン |
|---|---|---|
| Power Apps | Standard | US Government (GCC) |
| お問い合わせ先 | |
|---|---|
| 件名 | Adobe Acrobat Sign サポート |
| [URL] | https://helpx.adobe.com/contact/enterprise-support.dc.html#sign |
| メール | support@echosign.zendesk.com |
| Connector Metadata | |
|---|---|
| 発行者 | Adobe Inc. |
| Web サイト | https://acrobat.adobe.com/us/en/sign.html |
| プライバシー ポリシー | https://www.adobe.com/privacy/policy.html |
| カテゴリー | Web サイト |
Adobe Acrobat Sign
Adobe は、世界で最も信頼されているデジタル ドキュメント署名サービスです。 Adobe Acrobat Sign を使用して、手動のプロセスをすべてデジタル エクスペリエンスに変換することができます。 Adobe Acrobat Sign 機能をお使いのアプリケーションに組み込んで、契約のステータスの作成、送信、および監視を行います。
公開元: Adobe, Inc.
前提条件
Adobe Acrobat Sign アカウントが必要です。
コネクタの使用を開始する
コネクターのユーザーガイド https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html
よくあるご質問
コネクターのユーザーガイド https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| すべてのライブラリ テンプレートのリストを取得します |
この操作を実行すると、テンプレートとして保存されているすべてのドキュメントのリストが、ユーザーの Adobe Acrobat Sign ライブラリでフェッチされます。 |
| すべての契約のリストを取得します |
この操作を実行すると、ユーザーのすべての契約のリストが取得されます。 |
| アップロードされたドキュメントからライブラリ テンプレートを作成します |
この操作により、アップロードされたドキュメントから Adobe Acrobat Sign ライブラリでテンプレートが作成されます。 このテンプレートを使用して契約を送信します。 |
| アップロードされたドキュメントから契約を作成し、署名用に送信します |
この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。 |
| ドキュメント URL からライブラリ テンプレートを作成します |
この操作により、ドキュメント URL から Adobe Acrobat Sign ライブラリでテンプレートが作成されます。 このテンプレートを使用して契約を送信します |
| ドキュメント URL から契約を作成し、署名用に送信します |
この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。 |
| ドキュメントをアップロードしてドキュメント ID を取得します |
この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、そのドキュメント ID を返します。 このドキュメントは一時的に Adobe Acrobat Sign に保存され、契約の作成などの他の操作にドキュメント ID を使用することができます。 |
| ライブラリ テンプレートから契約を作成し、署名用に送信します |
この操作により、ユーザーの Adobe Acrobat Sign ライブラリに保存されているテンプレートから契約が作成され、署名用に送信されます。 |
| 契約からすべてのドキュメント ID の一覧を取得する |
この操作では、契約のすべてのドキュメントとサポート ドキュメントの ID をフェッチします。 |
| 契約からドキュメントを取得する |
この操作では、契約の特定のドキュメントのファイル ストリームをフェッチします。 |
| 契約のフォーム フィールド データを CSV 形式で取得する |
契約の対話型フォーム フィールドに入力されたデータを取得します。 |
| 契約のフォーム フィールド データを JSON 形式で取得する |
契約の対話型フォーム フィールドに入力されたデータを取得します。 |
| 契約のフォーム フィールドのデータを取得する (旧) [非推奨] |
契約の対話型フォーム フィールドに入力されたデータを取得します。 |
| 契約の状態を取得する |
この操作では、状態など、契約の現在の情報をすべてフェッチします。 |
| 契約を取り消す |
パスが含む agreementId で識別した契約をキャンセルします。 |
| 署名 URL を取得する |
この操作では、契約の現在の署名者の電子署名ページの URL を取得します。 |
| 署名された契約書の PDF を入手する |
この操作では、結合された、または署名された契約の PDF ファイル ストリームをフェッチします。 ファイル ストリームは、ファイル拡張子が .pdf で終わるファイル名で保存する必要があることに注意してください。 |
すべてのライブラリ テンプレートのリストを取得します
この操作を実行すると、テンプレートとして保存されているすべてのドキュメントのリストが、ユーザーの Adobe Acrobat Sign ライブラリでフェッチされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
ページ間の移動に使用します。 指定しない場合は、最初のページを返します。 |
|
|
ページ サイズ
|
pageSize | integer |
応答ページの項目数です。 既定: 100; 最大: 10000 |
戻り値
ライブラリ テンプレート配列オブジェクトを含む JSON
- Body
- LibraryDocuments
すべての契約のリストを取得します
この操作を実行すると、ユーザーのすべての契約のリストが取得されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カーソル
|
cursor | string |
ページ間の移動に使用します。 指定しない場合は、最初のページを返します。 |
|
|
ページ サイズ
|
pageSize | integer |
応答ページの項目数です。 既定: 100; 最大: 10000 |
戻り値
ユーザー契約配列オブジェクトを含む JSON
- Body
- userAgreementListV6
アップロードされたドキュメントからライブラリ テンプレートを作成します
この操作により、アップロードされたドキュメントから Adobe Acrobat Sign ライブラリでテンプレートが作成されます。 このテンプレートを使用して契約を送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート名
|
name | True | string |
テンプレートを識別するのに使用する契約名 |
|
テンプレートのタイプ
|
templateTypes | True | array of string |
1 つまたは複数のライブラリ テンプレートの種類のリスト |
|
共有モード
|
sharingMode | True | string |
このライブラリ ドキュメントへのアクセス許可を与えるユーザーを指定します |
|
ID
|
transientDocumentId | True | string |
一時ドキュメントをアップロードして受信したドキュメント ID |
|
テンプレートの状態
|
state | True | string |
ライブラリ ドキュメントの状態です。 |
戻り値
ライブラリ テンプレートを説明する JSON オブジェクト
アップロードされたドキュメントから契約を作成し、署名用に送信します
この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約名
|
name | True | string |
契約の名前 |
|
ID
|
transientDocumentId | True | string |
一時ドキュメントをアップロードして受信したドキュメント ID |
|
署名の種類
|
signatureType | True | string |
リクエストする署名の種類 - 電子署名または書面 |
|
参加者の電子メール
|
True | string |
参加者の電子メール |
|
|
認証
|
authenticationMethod | string |
既定の認証: メール (なし) |
|
|
パスワード
|
password | string |
参加者に対してパスワードを必須にする |
|
|
国番号
|
countryCode | string |
ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です |
|
|
電話番号。
|
phone | string |
契約書の表示と署名を行う際に必要な受信者の電話番号 |
|
|
並べ替え
|
order | True | integer |
インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。 |
|
役割
|
role | True | string |
関係者が設定した現在のロール (署名者、承認者など) です。 |
|
メッセージ
|
message | string |
アクションを要求する受信者に対するオプションのメッセージ |
|
|
電子メール
|
string |
契約の CC の電子メール |
||
|
有効期限
|
expirationTime | string |
契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z |
|
|
アラームの頻度
|
reminderFrequency | string |
通知を送信する頻度を指定してください。 |
|
|
ドキュメントのパスワード
|
openPassword | string |
署名済み契約 PDF を暗号化するために使用するパスワード |
|
|
件名
|
fieldName | string |
フィールドの名前 |
|
|
値
|
defaultValue | string |
フィールドの既定値 |
|
|
リダイレクト遅延
|
redirectDelay | string |
ユーザーが成功ページに移動するまでの遅延時間 (秒) です。 |
|
|
リダイレクト URL
|
redirectUrl | string |
署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com) |
|
|
最初のメール
|
initEmails | string |
契約開始イベントの通知メールを管理します。 |
戻り値
新しく作成された契約の ID を含む JSON
ドキュメント URL からライブラリ テンプレートを作成します
この操作により、ドキュメント URL から Adobe Acrobat Sign ライブラリでテンプレートが作成されます。 このテンプレートを使用して契約を送信します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート名
|
name | True | string |
テンプレートを識別するのに使用する契約名 |
|
テンプレートのタイプ
|
templateTypes | True | array of string |
1 つまたは複数のライブラリ テンプレートの種類のリスト |
|
共有モード
|
sharingMode | True | string |
このライブラリ ドキュメントへのアクセス許可を与えるユーザーを指定します |
|
URL
|
url | True | string |
未処理のファイル コンテンツを取得するための外部にアクセス可能な URL |
|
件名
|
name | True | string |
送信されるドキュメントの元のシステム ファイル名 |
|
タイプ
|
mimeType | True | string |
参照先ファイルの MIME の種類 (例: アプリケーション/pdf) |
|
テンプレートの状態
|
state | True | string |
ライブラリ ドキュメントの状態です。 |
戻り値
ライブラリ テンプレートを説明する JSON オブジェクト
ドキュメント URL から契約を作成し、署名用に送信します
この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約名
|
name | True | string |
契約の名前 |
|
URL
|
url | True | string |
未処理のファイル コンテンツを取得するための外部にアクセス可能な URL |
|
件名
|
name | True | string |
送信されるドキュメントの元のシステム ファイル名 |
|
タイプ
|
mimeType | True | string |
参照先ファイルの MIME の種類 (例: アプリケーション/pdf) |
|
署名の種類
|
signatureType | True | string |
電子署名または書面で要求された署名の種類を指定します |
|
参加者の電子メール
|
True | string |
参加者の電子メール |
|
|
認証
|
authenticationMethod | string |
既定の認証: メール (なし) |
|
|
パスワード
|
password | string |
参加者に対してパスワードを必須にする |
|
|
国番号
|
countryCode | string |
ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です |
|
|
電話番号。
|
phone | string |
契約書の表示と署名を行う際に必要な受信者の電話番号 |
|
|
並べ替え
|
order | True | integer |
インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。 |
|
役割
|
role | True | string |
関係者が設定した現在のロール (署名者、承認者など) です。 |
|
メッセージ
|
message | string |
アクションを要求する受信者に対するオプションのメッセージ |
|
|
電子メール
|
string |
契約の CC の電子メール |
||
|
有効期限
|
expirationTime | string |
契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z |
|
|
アラームの頻度
|
reminderFrequency | string |
通知を送信する頻度を指定してください。 |
|
|
ドキュメントのパスワード
|
openPassword | string |
署名済み契約 PDF を暗号化するために使用するパスワード |
|
|
件名
|
fieldName | string |
フィールドの名前 |
|
|
値
|
defaultValue | string |
フィールドの既定値 |
|
|
リダイレクト遅延
|
redirectDelay | string |
ユーザーが成功ページに移動するまでの遅延時間 (秒) です。 |
|
|
リダイレクト URL
|
redirectUrl | string |
署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com) |
|
|
最初のメール
|
initEmails | string |
契約開始イベントの通知メールを管理します。 |
戻り値
新しく作成された契約の ID を含む JSON
ドキュメントをアップロードしてドキュメント ID を取得します
この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、そのドキュメント ID を返します。 このドキュメントは一時的に Adobe Acrobat Sign に保存され、契約の作成などの他の操作にドキュメント ID を使用することができます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル名
|
File-Name | True | string |
アップロードするドキュメントの名前 (拡張子付き) |
|
ファイル コンテンツ
|
File | True | contentOnly |
アップロードするドキュメントのファイル ストリーム |
戻り値
アップロードされたドキュメントの ID を含む JSON
ライブラリ テンプレートから契約を作成し、署名用に送信します
この操作により、ユーザーの Adobe Acrobat Sign ライブラリに保存されているテンプレートから契約が作成され、署名用に送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約名
|
name | True | string |
契約の名前 |
|
テンプレート
|
libraryDocumentId | True | string |
ライブラリに保存されているテンプレートからドキュメントを選択します |
|
署名の種類
|
signatureType | True | string |
リクエストする署名の種類 - 電子署名または書面 |
|
参加者の電子メール
|
True | string |
参加者の電子メール |
|
|
認証
|
authenticationMethod | string |
既定の認証: メール (なし) |
|
|
パスワード
|
password | string |
参加者に対してパスワードを必須にする |
|
|
国番号
|
countryCode | string |
ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です |
|
|
電話番号。
|
phone | string |
契約書の表示と署名を行う際に必要な受信者の電話番号 |
|
|
並べ替え
|
order | True | integer |
インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。 |
|
役割
|
role | True | string |
関係者が設定した現在のロール (署名者、承認者など) です。 |
|
メッセージ
|
message | string |
アクションを要求する受信者に対するオプションのメッセージ |
|
|
電子メール
|
string |
契約の CC の電子メール |
||
|
有効期限
|
expirationTime | string |
契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z |
|
|
アラームの頻度
|
reminderFrequency | string |
通知を送信する頻度を指定してください。 |
|
|
ドキュメントのパスワード
|
openPassword | string |
署名済み契約 PDF を暗号化するために使用するパスワード |
|
|
件名
|
fieldName | string |
フィールドの名前 |
|
|
値
|
defaultValue | string |
フィールドの既定値 |
|
|
リダイレクト遅延
|
redirectDelay | string |
ユーザーが成功ページに移動するまでの遅延時間 (秒) です。 |
|
|
リダイレクト URL
|
redirectUrl | string |
署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com) |
|
|
最初のメール
|
initEmails | string |
契約開始イベントの通知メールを管理します。 |
戻り値
新しく作成された契約の ID を含む JSON
契約からすべてのドキュメント ID の一覧を取得する
この操作では、契約のすべてのドキュメントとサポート ドキュメントの ID をフェッチします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
ドキュメントが必要な契約の契約 ID |
|
サポート ドキュメント - コンテンツ タイプ
|
supportingDocumentContentFormat | string |
契約のサポート ドキュメントのコンテンツ タイプ |
戻り値
ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON
- 本文
- AgreementDocumentsV6
契約からドキュメントを取得する
この操作では、契約の特定のドキュメントのファイル ストリームをフェッチします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
ドキュメントが必要な契約の契約 ID |
|
ドキュメント ID
|
documentId | True | string |
契約の特定のドキュメントのドキュメント ID |
戻り値
ドキュメントのファイルストリーム
契約のフォーム フィールド データを CSV 形式で取得する
契約の対話型フォーム フィールドに入力されたデータを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
情報が必要な契約の契約 ID |
戻り値
フォーム データのコンテンツ
- フォーム データのコンテンツ
- binary
契約のフォーム フィールド データを JSON 形式で取得する
契約の対話型フォーム フィールドに入力されたデータを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
情報が必要な契約の契約 ID |
戻り値
フォーム データのコンテンツ
- フォーム データのコンテンツ
- object
契約のフォーム フィールドのデータを取得する (旧) [非推奨]
契約の対話型フォーム フィールドに入力されたデータを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
情報が必要な契約の契約 ID |
戻り値
- 返答
- file
契約の状態を取得する
この操作では、状態など、契約の現在の情報をすべてフェッチします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
情報が必要な契約の契約 ID |
戻り値
完全な契約の詳細
- Body
- AgreementInfoV6
契約を取り消す
パスが含む agreementId で識別した契約をキャンセルします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
取り消す対象の契約が持つ契約 ID。 |
|
契約の状態
|
state | string |
契約を得る必要がある状態です。 |
|
|
コメント
|
comment | string |
受信者にキャンセルの理由を説明するオプションのコメント。 |
|
|
その他
|
notifyOthers | boolean |
受信者に通知するかどうか。 |
署名 URL を取得する
この操作では、契約の現在の署名者の電子署名ページの URL を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
契約を作成したアクションで指定された契約 ID |
戻り値
- Body
- SigningUrlResponse
署名された契約書の PDF を入手する
この操作では、結合された、または署名された契約の PDF ファイル ストリームをフェッチします。 ファイル ストリームは、ファイル拡張子が .pdf で終わるファイル名で保存する必要があることに注意してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 ID
|
agreementId | True | string |
契約を作成したアクションで指定された契約 ID |
|
サポート ドキュメントを添付?
|
attachSupportingDocuments | boolean |
true の場合、署名された契約 PDF にサポート ドキュメントを添付 |
|
|
監査レポートを添付?
|
attachAuditReport | boolean |
true の場合、署名された契約 PDF に監査レポートを添付 |
戻り値
ドキュメントのファイルストリーム
トリガー
| イベントが発生した場合 |
イベントが発生するときに新しいフローをトリガーします。 すべての契約、メガ サイン、ウィジェット イベントをカバーしています。 |
| 契約が参加者に送信される場合 |
契約が参加者に送信されるときに、新しいフローをトリガーします。 |
| 契約の状態を変更するとき |
契約の状態が変更されると新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントをカバーします。 |
| 契約ワークフローが正常に完了したとき |
契約ワークフローが正常に完了したときに新しいフローをトリガーします |
| 新しい契約が作成される場合 |
新しい契約が作成された時に、新しいフローをトリガーします。 |
イベントが発生した場合
イベントが発生するときに新しいフローをトリガーします。 すべての契約、メガ サイン、ウィジェット イベントをカバーしています。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
トリガーの名前 |
|
Scope
|
scope | True | string |
トリガーのスコープ |
|
リソースの種類
|
resourceType | string |
「スコープ」が「特定契約」の場合のみ指定します。 フローをトリガーするリソース タイプを選択します。 |
|
|
リソース ID
|
resourceId | string |
「スコープ」が「特定契約」の場合のみ指定します。 フローをトリガーする契約、メガ サインまたはウィジェット ID を入力します。 |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
フローをトリガーするイベント |
|
契約情報を含めますか?
|
includeDetailedInfo | boolean |
詳細な契約情報を通知する必要がありますか? |
|
|
契約の参加者情報を含めますか?
|
includeParticipantsInfo | boolean |
契約の参加者情報を通知する必要がありますか? |
|
|
契約ドキュメントの情報を含めますか?
|
includeDocumentsInfo | boolean |
契約ドキュメントの情報を通知する必要がありますか? |
|
|
契約の署名済みドキュメントの情報を含めますか?
|
includeSignedDocuments | boolean |
契約完了時に署名されたドキュメントの最終コピーを通知する必要がありますか? |
|
|
MegaSign の情報を含めますか?
|
includeDetailedInfo | boolean |
詳細なメガ サインの情報を通知する必要がありますか? |
|
|
ウィジェットの情報を含めますか?
|
includeDetailedInfo | boolean |
詳細なウィジェットの情報を通知する必要がありますか? |
|
|
ウィジェットの参加者情報を含めますか?
|
includeParticipantsInfo | boolean |
ウィジェットの参加者情報を通知する必要がありますか? |
|
|
ウィジェット ドキュメントの情報を含めますか?
|
includeDocumentsInfo | boolean |
ウィジェット ドキュメントの情報を通知する必要がありますか? |
戻り値
契約が参加者に送信される場合
契約が参加者に送信されるときに、新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
トリガーの名前 |
|
Scope
|
scope | True | string |
トリガーのスコープ |
|
契約名/ID
|
resourceId | string |
「スコープ」が「特定契約」の場合のみ指定します。 一覧から契約を選択するか、契約 ID を入力します。 |
|
|
サブスクリプション
|
webhookSubscriptionEvents | True | array of string |
フローをトリガーするイベント |
|
契約情報を含めますか?
|
includeDetailedInfo | boolean |
詳細な契約情報を通知する必要がありますか? |
|
|
契約の参加者情報を含めますか?
|
includeParticipantsInfo | boolean |
契約の参加者情報を通知する必要がありますか? |
|
|
契約ドキュメントの情報を含めますか?
|
includeDocumentsInfo | boolean |
契約ドキュメントの情報を通知する必要がありますか? |
戻り値
- 本文
- WebhookPayload
契約の状態を変更するとき
契約の状態が変更されると新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントをカバーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
トリガーの名前 |
|
Scope
|
scope | True | string |
トリガーのスコープ |
|
契約名/ID
|
resourceId | string |
「スコープ」が「特定契約」の場合のみ指定します。 一覧から契約を選択するか、契約 ID を入力します。 |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
フローをトリガーするイベント |
|
契約情報を含めますか?
|
includeDetailedInfo | boolean |
詳細な契約情報を通知する必要がありますか? |
|
|
契約の参加者情報を含めますか?
|
includeParticipantsInfo | boolean |
契約の参加者情報を通知する必要がありますか? |
|
|
契約ドキュメントの情報を含めますか?
|
includeDocumentsInfo | boolean |
契約ドキュメントの情報を通知する必要がありますか? |
|
|
契約の署名済みドキュメントの情報を含めますか?
|
includeSignedDocuments | boolean |
契約完了の通知の際に、署名されたドキュメントの最終コピーを送信する必要がありますか? |
戻り値
契約ワークフローが正常に完了したとき
契約ワークフローが正常に完了したときに新しいフローをトリガーします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
トリガーの名前 |
|
Scope
|
scope | True | string |
トリガーのスコープ |
|
契約名/ID
|
resourceId | string |
「スコープ」が「特定契約」の場合のみ指定します。 一覧から契約を選択するか、契約 ID を入力します。 |
|
|
サブスクリプション
|
webhookSubscriptionEvents | True | array of string |
フローをトリガーするイベント |
|
契約情報を含めますか?
|
includeDetailedInfo | boolean |
詳細な契約情報を通知する必要がありますか? |
|
|
契約の参加者情報を含めますか?
|
includeParticipantsInfo | boolean |
契約の参加者情報を通知する必要がありますか? |
|
|
契約ドキュメントの情報を含めますか?
|
includeDocumentsInfo | boolean |
契約ドキュメントの情報を通知する必要がありますか? |
|
|
契約の署名済みドキュメントの情報を含めますか?
|
includeSignedDocuments | boolean |
契約完了時に署名されたドキュメントの最終コピーを通知する必要がありますか? |
戻り値
新しい契約が作成される場合
新しい契約が作成された時に、新しいフローをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
トリガーの名前 |
|
範囲
|
scope | True | string |
トリガーのスコープ |
|
サブスクリプション
|
webhookSubscriptionEvents | True | array of string |
フローをトリガーするイベント |
|
契約情報を含めますか?
|
includeDetailedInfo | boolean |
詳細な契約情報を通知する必要がありますか? |
|
|
契約の参加者情報を含めますか?
|
includeParticipantsInfo | boolean |
契約の参加者情報を通知する必要がありますか? |
戻り値
定義
AgreementCreationResponseV6
新しく作成された契約の ID を含む JSON
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約 ID
|
id | string |
状態のクエリと署名されたドキュメントのダウンロードに使用できる、契約の一意の ID |
AgreementDocumentsV6
ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント
|
documents | array of DocumentV6 |
ドキュメントを表すオブジェクトの一覧 |
|
サポート ドキュメント
|
supportingDocuments | array of SupportingDocumentV6 |
サポート ドキュメントの一覧。 これは、契約書にサポート ドキュメントがある場合のみ返される |
AgreementInfoV6
完全な契約の詳細
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約 ID
|
id | string |
契約を一意に識別するために使用できる一意の ID |
|
作成日
|
createdDate | date |
契約が作成された日付 |
|
最初のアラームの遅延
|
firstReminderDelay | integer |
最初のアラームを送信するまでの遅延を時間単位で指定する整数です。 |
|
アラームの頻度
|
reminderFrequency | string |
アラームを送信する頻度は? |
|
有効期限
|
expiration | date |
契約書に署名できなくなる日付 |
|
ロケール
|
locale | string |
この契約に関連付けられているロケール - (例: en_US、fr_FR) |
|
メッセージ
|
message | string |
送信者が提供した契約に関連するメッセージ |
|
契約名
|
name | string |
送信者が指定した契約の名前 |
|
ドキュメントの可視性?
|
documentVisibilityEnabled | boolean |
ドキュメントの可視性は有効になっていますか? |
|
参加者セット
|
participantSetsInfo | array of ParticipantSetInfoV6 |
このドキュメントのすべての参加者セットに関する情報 |
|
署名の種類
|
signatureType | string |
電子署名または書面で要求された署名の種類を指定します |
|
セキュリティのオプション
|
securityOptions | string |
ドキュメントの表示と署名にパスワードが必要かどうかを指定する、ドキュメントに関するセキュリティ情報 |
|
ステータス
|
status | string |
契約の現在の状態 |
|
送信者の電子メール
|
senderEmail | string |
送信者の電子メール |
|
ワークフロー ID
|
workflowId | string |
契約のルーティング パスを定義するカスタム ワークフローの ID です。 |
|
CC
|
ccs | array of CcInfo |
契約トランザクションでコピーされる 1 つ以上の CC の一覧。 |
CombinedDocumentResponse
DisplayUserInfo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
会社
|
company | string |
ユーザーの会社名を表示 (可能な場合) |
|
電子メール
|
string |
ユーザーの電子メールを表示 |
|
|
氏名
|
fullName | string |
ユーザーのフル ネームを表示します (可能な場合)。 |
DisplayUserSetInfo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー セット情報の表示
|
displayUserSetMemberInfos | array of DisplayUserInfo |
ユーザー セットに関する情報を表示 |
|
ユーザー セット名の表示
|
displayUserSetName | string |
DocumentV6
ドキュメントに関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Document ID
|
id | string |
ドキュメントの一意 ID |
|
MIME の種類
|
mimeType | string |
ドキュメントの MIME の種類 |
|
件名
|
name | string |
ドキュメントの名前 |
|
ページ数
|
numPages | integer |
ドキュメントのページ数 |
DocumentResponse
ParticipantSetInfoV6
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
参加者セット メンバーの情報
|
memberInfos | array of MemberInfosV6 |
受信者セットのメンバーに関する情報 |
|
並べ替え
|
order | integer |
署名するグループが署名する必要がある場所を示すインデックスです。 |
|
役割
|
role | string |
関係者が設定した現在のロール (署名者、承認者など) です。 |
|
参加者セット名
|
name | string |
参加者セットの名前 |
|
参加者セットのプライベート メッセージ
|
privateMessage | string |
セット内の参加者のプライベート メッセージ |
|
参加者セット表示ページ
|
visiblePages | array of string |
参加者セットに表示されるページ |
MemberInfosV6
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
参加者の電子メール
|
string |
参加者の電子メール |
|
|
認証
|
securityOption.authenticationMethod | string |
既定の認証: メール (なし) |
|
パスワード
|
securityOption.password | string |
参加者に対してパスワードを必須にする |
|
国番号
|
securityOption.phoneInfo.countryCode | string |
ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です |
|
電話番号。
|
securityOption.phoneInfo.phone | string |
契約書の表示と署名を行う際に必要な受信者の電話番号 |
SigningUrl
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名 URL 用の電子メール
|
string |
この署名 URL に関連付けられている署名者の電子メール アドレス |
|
|
署名 URL
|
esignUrl | string |
この署名 URL に関連付けられている署名者の URL アドレス |
SigningUrlResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名者セットの URL の配列
|
signingUrlSetInfos | array of SigningUrlSetInfo |
この契約に関与する署名者セットの URL の配列 |
SigningUrlSetInfo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
- 署名 URL 配列
|
signingUrls | array of SigningUrl |
現在の署名者セットの URL の配列 |
|
- 署名 URL セット名
|
signingUrlSetName | string |
現在の署名者セットの名前 |
SupportingDocumentV6
サポート ドキュメントに関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
サポート ドキュメント名
|
displayLabel | string |
サポート ドキュメントの表示名 |
|
サポート ドキュメント フィールド名
|
fieldName | string |
サポート ドキュメント フィールド名前 |
|
サポート ドキュメントの MIME の種類
|
mimeType | string |
サポート ドキュメントの MIME の種類 |
|
サポート ドキュメント ページ
|
numPages | integer |
サポート ドキュメントのページ数 |
|
サポート ドキュメント ID
|
id | string |
サポート ドキュメントを表す一意の ID |
TransientDocumentResponse
アップロードされたドキュメントの ID を含む JSON
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Document ID
|
transientDocumentId | string |
アップロードされるドキュメントのドキュメント ID |
UserAgreementV6
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー セット情報の表示
|
displayParticipantSetInfos | array of DisplayUserSetInfo |
契約に最も関連性の高い現在のユーザー セットです。 通常、現在のユーザーからの契約であれば次の署名者、他のユーザーからの契約であれば送信者 |
|
日付の表示
|
displayDate | string |
契約の表示日 |
|
電子署名
|
esign | boolean |
これが電子署名ドキュメントである場合は True |
|
非表示
|
hidden | boolean |
ユーザーに対して契約が非表示の場合は True |
|
グループ ID
|
groupId | string |
グループを表す一意の識別子 |
|
最新バージョン ID
|
latestVersionId | string |
契約の現在のバージョンを一意に識別するバージョン ID |
|
件名
|
name | string |
契約の名前 |
|
親 ID
|
parentId | string |
megaSign の子の親 ID、またはウィジェットの契約インスタンスの元になる ID |
|
契約 ID
|
id | string |
契約を表す一意の識別子 |
|
ステータス
|
status | string |
契約の現在の状態 |
|
タイプ
|
type | string |
契約の種類 |
userAgreementListV6
ユーザー契約配列オブジェクトを含む JSON
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ページ
|
page | page |
応答内の移動のための改ページ情報 |
|
契約リスト
|
userAgreementList | array of UserAgreementV6 |
契約項目の配列 |
ページ
応答内の移動のための改ページ情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
nextCursor
|
nextCursor | string |
次のページに移動するときに使用されます。 返されない場合は、それ以上のページはありません。 |
WebhookPayload
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント
|
event | string |
リソースで発生したイベントです。 |
|
イベントの日付
|
eventDate | date |
イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す) |
|
イベントのリソースの種類
|
eventResourceType | string |
イベントが発生したリソースです。 |
|
契約の親の種類
|
eventResourceParentType | string |
契約が作成されたリソースに関する情報です。 指定できる値: ウィジェットまたは メガ サイン |
|
契約の親の ID
|
eventResourceParentId | string |
この契約が作成されたリソースの一意の ID |
|
イベント参加者ロール
|
participantRole | string |
イベントの参加者のロールです。 |
|
イベント参加者 ID
|
participantUserId | string |
イベントの参加者の IDです。 |
|
イベント参加者電子メール
|
participantUserEmail | string |
イベントの参加者の電子メールです。 |
|
イベント アクティング ユーザー ID
|
actingUserId | string |
イベントを作成したユーザーの ID です。 |
|
イベント アクティング ユーザーの電子メール
|
actingUserEmail | string |
イベントを作成したユーザーの電子メールです。 |
|
イベント アクティング ユーザー IP アドレス
|
actingUserIpAddress | string |
イベントを作成したユーザーの IP アドレス |
|
イベント開始ユーザー ID
|
initiatingUserId | string |
アクティング ユーザーに代わってイベントを開始したユーザーの ID です。 |
|
イベント開始ユーザーの電子メール
|
initiatingUserEmail | string |
アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。 |
|
通知適用対象ユーザー
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
この通知が適用対象のユーザーの一覧 |
|
契約
|
agreement | WebhookAgreementInfo |
契約の詳細情報 |
ApplicableUsers
この通知が適用されるユーザーに関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
通知適用対象ユーザー ID
|
id | string |
この通知が適用されるユーザーの一意の ID |
|
通知適用対象ユーザーの電子メール
|
string |
この通知が適用されるユーザーの電子メール |
|
|
通知適用対象ユーザーのロール
|
role | string |
この通知が生成されるワークフローでのユーザーのロール |
|
ペイロード適用対象ユーザーか
|
payloadApplicable | boolean |
この通知で提供されるデータがこのユーザーに適用されるかどうか |
WebhookPayloadWithoutNextParticipantSet
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント
|
event | string |
リソースで発生したイベントです。 |
|
イベントの日付
|
eventDate | date |
イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す) |
|
イベントのリソースの種類
|
eventResourceType | string |
イベントが発生したリソースです。 |
|
契約の親の種類
|
eventResourceParentType | string |
契約が作成されたリソースに関する情報です。 指定できる値: ウィジェットまたは メガ サイン |
|
契約の親の ID
|
eventResourceParentId | string |
この契約が作成されたリソースの一意の ID |
|
イベント参加者 ID
|
participantUserId | string |
イベントの参加者の IDです。 |
|
イベント参加者電子メール
|
participantUserEmail | string |
イベントの参加者の電子メールです。 |
|
イベント アクティング ユーザー ID
|
actingUserId | string |
イベントを作成したユーザーの ID です。 |
|
イベント アクティング ユーザーの電子メール
|
actingUserEmail | string |
イベントを作成したユーザーの電子メールです。 |
|
イベント アクティング ユーザー IP アドレス
|
actingUserIpAddress | string |
イベントを作成したユーザーの IP アドレス |
|
イベント開始ユーザー ID
|
initiatingUserId | string |
アクティング ユーザーに代わってイベントを開始したユーザーの ID |
|
イベント開始ユーザーの電子メール
|
initiatingUserEmail | string |
アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。 |
|
通知適用対象ユーザー
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
この通知が適用対象のユーザーの一覧 |
|
契約
|
agreement | WebhookAgreementInfoWithoutNextParticipantSet |
契約の詳細情報 |
WebhookPayloadWithSignedDocumentForStatusChange
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント
|
event | string |
リソースで発生したイベントです。 |
|
イベントの日付
|
eventDate | date |
イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す) |
|
サブ イベント
|
subEvent | string |
リソースで発生したサブ イベントです。 |
|
契約の親の種類
|
eventResourceParentType | string |
契約が作成されたリソースに関する情報です。 指定できる値: ウィジェットまたは メガ サイン |
|
契約の親の ID
|
eventResourceParentId | string |
この契約が作成されたリソースの一意の ID |
|
イベント参加者 ID
|
participantUserId | string |
イベントの参加者の IDです。 |
|
イベント参加者電子メール
|
participantUserEmail | string |
イベントの参加者の電子メールです。 |
|
イベント アクティング ユーザー ID
|
actingUserId | string |
イベントを作成したユーザーの ID です。 |
|
イベント アクティング ユーザーの電子メール
|
actingUserEmail | string |
イベントを作成したユーザーの電子メールです。 |
|
イベント アクティング ユーザー IP アドレス
|
actingUserIpAddress | string |
イベントを作成したユーザーの IP アドレス |
|
アクションの種類
|
actionType | string |
イベントが発生したアクションです。 |
|
イベント開始ユーザー ID
|
initiatingUserId | string |
アクティング ユーザーに代わってイベントを開始したユーザーの ID |
|
イベント開始ユーザーの電子メール
|
initiatingUserEmail | string |
アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。 |
|
イベントのリソースの種類
|
eventResourceType | string |
イベントが発生したリソースです。 |
|
イベント参加者ロール
|
participantRole | string |
イベントの参加者のロールです。 |
|
通知適用対象ユーザー
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
この通知が適用対象のユーザーの一覧 |
|
契約
|
agreement | WebhookAgreementInfoWithSignedDocument |
契約の詳細情報 |
WebhookPayloadWithSignedDocument
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント
|
event | string |
リソースで発生したイベントです。 |
|
イベントの日付
|
eventDate | date |
イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す) |
|
契約の親の種類
|
eventResourceParentType | string |
契約が作成されたリソースに関する情報です。 指定できる値: ウィジェットまたは メガ サイン |
|
契約の親の ID
|
eventResourceParentId | string |
この契約が作成されたリソースの一意の ID |
|
イベントのリソースの種類
|
eventResourceType | string |
イベントが発生したリソースです。 |
|
イベント参加者ロール
|
participantRole | string |
イベントの参加者のロールです。 |
|
イベント参加者 ID
|
participantUserId | string |
イベントの参加者の IDです。 |
|
イベント参加者電子メール
|
participantUserEmail | string |
イベントの参加者の電子メールです。 |
|
イベント アクティング ユーザー ID
|
actingUserId | string |
イベントを作成したユーザーの ID です。 |
|
イベント アクティング ユーザーの電子メール
|
actingUserEmail | string |
イベントを作成したユーザーの電子メールです。 |
|
イベント アクティング ユーザー IP アドレス
|
actingUserIpAddress | string |
イベントを作成したユーザーの IP アドレス |
|
イベント開始ユーザー ID
|
initiatingUserId | string |
アクティング ユーザーに代わってイベントを開始したユーザーの ID |
|
イベント開始ユーザーの電子メール
|
initiatingUserEmail | string |
アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。 |
|
通知適用対象ユーザー
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
この通知が適用対象のユーザーの一覧 |
|
契約
|
agreement | WebhookAgreementInfoWithSignedDocument |
契約の詳細情報 |
WebhookPayloadGeneric
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
イベント
|
event | string |
リソースで発生したイベントです。 |
|
イベントの日付
|
eventDate | date |
イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す) |
|
サブ イベント
|
subEvent | string |
リソースで発生したサブ イベントです。 |
|
契約の親の種類
|
eventResourceParentType | string |
契約が作成されたリソースに関する情報です。 指定できる値: ウィジェットまたは メガ サイン |
|
契約の親の ID
|
eventResourceParentId | string |
この契約が作成されたリソースの一意の ID |
|
イベントのリソースの種類
|
eventResourceType | string |
イベントが発生したリソースです。 |
|
イベント参加者ロール
|
participantRole | string |
イベントの参加者のロールです。 |
|
イベント参加者 ID
|
participantUserId | string |
イベントの参加者の IDです。 |
|
イベント参加者電子メール
|
participantUserEmail | string |
イベントの参加者の電子メールです。 |
|
イベント アクティング ユーザー ID
|
actingUserId | string |
イベントを作成したユーザーの ID です。 |
|
イベント アクティング ユーザーの電子メール
|
actingUserEmail | string |
イベントを作成したユーザーの電子メールです。 |
|
イベント開始ユーザー ID
|
initiatingUserId | string |
アクティング ユーザーに代わってイベントを開始したユーザーの ID |
|
イベント開始ユーザーの電子メール
|
initiatingUserEmail | string |
アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。 |
|
アクションの種類
|
actionType | string |
イベントが発生したアクションです。 |
|
イベント アクティング ユーザー IP アドレス
|
actingUserIpAddress | string |
イベントを作成したユーザーの IP アドレス |
|
通知適用対象ユーザー
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
この通知が適用対象のユーザーの一覧 |
|
契約
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
契約の詳細情報 |
|
メガ サイン
|
megaSign | WebhookMegaSignInfo |
メガ サインの詳細情報 |
|
ウィジェット
|
widget | WebhookWidgetInfo |
ウィジェットの詳細情報 |
WebhookAgreementInfo
契約の詳細情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
契約の一意の ID |
|
件名
|
name | string |
契約の名前 |
|
署名の種類
|
signatureType | string |
電子署名または書面で要求された署名の種類を指定します |
|
ステータス
|
status | string |
契約の現在の状態 |
|
CC
|
ccs | array of CcInfo |
契約トランザクションでコピーされる 1 つ以上の CC の一覧。 |
|
作成日
|
createdDate | date |
契約が作成された日付 |
|
有効期限
|
expirationTime | string |
契約の有効期限が切れる前に必要な署名をするまでの時間 |
|
外部 ID
|
externalId.id | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
外部グループ
|
externalId.group | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
最初のアラームの遅延
|
firstReminderDelay | integer |
最初のアラームを送信するまでの遅延を時間単位で指定する整数です。 |
|
ロケール
|
locale | string |
この契約に関連付けられているロケール |
|
メッセージ
|
message | string |
送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ |
|
アラームの頻度
|
reminderFrequency | string |
参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用 |
|
送信者の電子メール
|
senderEmail | string |
契約の送信者の電子メール |
|
Vault は有効か?
|
vaultingInfo.enabled | boolean |
ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する |
|
ドキュメントの可視性?
|
documentVisibilityEnabled | boolean |
ドキュメントの可視性は有効になっているか |
|
ワークフロー ID
|
workflowId | string |
契約のルーティング パスを定義するカスタム ワークフローの ID です。 |
|
ポスト サインのリダイレクト URL
|
postSignOption.redirectUrl | string |
署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
|
参加者セット
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
参加者セット情報 |
|
次の参加者セット
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
次の参加者セット情報 |
|
ドキュメント
|
documentsInfo.documents | array of WebhookDocument |
ドキュメントを表すオブジェクトの一覧 |
|
サポート ドキュメント
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
サポート ドキュメントの一覧 |
WebhookAgreementInfoWithoutNextParticipantSet
契約の詳細情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
契約の一意の ID |
|
件名
|
name | string |
契約の名前 |
|
署名の種類
|
signatureType | string |
電子署名または書面で要求された署名の種類を指定します |
|
ステータス
|
status | string |
契約の現在の状態 |
|
CC
|
ccs | array of CcInfo |
契約トランザクションでコピーされる 1 つ以上の CC の一覧。 |
|
作成日
|
createdDate | date |
契約が作成された日付 |
|
ドキュメントの可視性?
|
documentVisibilityEnabled | boolean |
ドキュメントの可視性は有効になっているか |
|
有効期限
|
expirationTime | string |
契約の有効期限が切れる前に必要な署名をするまでの時間 |
|
外部 ID
|
externalId.id | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
外部グループ
|
externalId.group | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
最初のアラームの遅延
|
firstReminderDelay | integer |
最初のアラームを送信するまでの遅延を時間単位で指定する整数です。 |
|
ロケール
|
locale | string |
この契約に関連付けられているロケール |
|
メッセージ
|
message | string |
送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ |
|
アラームの頻度
|
reminderFrequency | string |
参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用 |
|
送信者の電子メール
|
senderEmail | string |
契約の送信者の電子メール |
|
Vault は有効か?
|
vaultingInfo.enabled | boolean |
ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する |
|
ポスト サインのリダイレクト URL
|
postSignOption.redirectUrl | string |
署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
|
ワークフロー ID
|
workflowId | string |
契約のルーティング パスを定義するカスタム ワークフローの ID です。 |
|
参加者セット
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
参加者セット情報 |
WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo
契約の詳細情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
契約の一意の ID |
|
件名
|
name | string |
契約の名前 |
|
署名の種類
|
signatureType | string |
電子署名または書面で要求された署名の種類を指定します |
|
ステータス
|
status | string |
契約の現在の状態 |
|
CC
|
ccs | array of CcInfo |
契約トランザクションでコピーされる 1 つ以上の CC の一覧。 |
|
作成日
|
createdDate | date |
契約が作成された日付 |
|
有効期限
|
expirationTime | string |
契約の有効期限が切れる前に必要な署名をするまでの時間 |
|
外部 ID
|
externalId.id | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
外部グループ
|
externalId.group | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
最初のアラームの遅延
|
firstReminderDelay | integer |
最初のアラームを送信するまでの遅延を時間単位で指定する整数です。 |
|
ロケール
|
locale | string |
この契約に関連付けられているロケール |
|
メッセージ
|
message | string |
送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ |
|
アラームの頻度
|
reminderFrequency | string |
参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用 |
|
ポスト サインのリダイレクト URL
|
postSignOption.redirectUrl | string |
署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
|
ワークフロー ID
|
workflowId | string |
契約のルーティング パスを定義するカスタム ワークフローの ID です。 |
|
送信者の電子メール
|
senderEmail | string |
契約の送信者の電子メール |
|
ドキュメントの可視性?
|
documentVisibilityEnabled | boolean |
ドキュメントの可視性は有効になっているか |
|
Vault は有効ですか?
|
vaultingInfo.enabled | boolean |
ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する |
|
参加者セット
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
参加者セット情報 |
|
次の参加者セット
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
次の参加者セット情報 |
|
ドキュメント
|
documentsInfo.documents | array of WebhookDocument |
ドキュメントを表すオブジェクトの一覧 |
|
サポート ドキュメント
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
サポート ドキュメントの一覧。これは、契約にサポート ドキュメントがある場合のみ返される |
|
署名されたドキュメント情報
|
signedDocumentInfo.document | string |
署名されたドキュメントの Base64 エンコード文字列 |
WebhookAgreementInfoWithSignedDocument
契約の詳細情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
契約の一意の ID |
|
件名
|
name | string |
契約の名前 |
|
署名の種類
|
signatureType | string |
電子署名または書面で要求された署名の種類を指定します |
|
ステータス
|
status | string |
契約の現在の状態 |
|
CC
|
ccs | array of CcInfo |
契約トランザクションでコピーされる 1 つ以上の CC の一覧 |
|
作成日
|
createdDate | date |
契約が作成された日付 |
|
ドキュメントの可視性?
|
documentVisibilityEnabled | boolean |
ドキュメントの可視性は有効になっているか |
|
有効期限
|
expirationTime | string |
契約の有効期限が切れる前に必要な署名をするまでの時間 |
|
外部 ID
|
externalId.id | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
外部グループ
|
externalId.group | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
最初のアラームの遅延
|
firstReminderDelay | integer |
最初のアラームを送信するまでの遅延を時間単位で指定する整数です。 |
|
ロケール
|
locale | string |
この契約に関連付けられているロケール |
|
メッセージ
|
message | string |
送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ |
|
アラームの頻度
|
reminderFrequency | string |
参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用 |
|
送信者の電子メール
|
senderEmail | string |
契約の送信者の電子メール |
|
Vault は有効か?
|
vaultingInfo.enabled | boolean |
ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する |
|
ポスト サインのリダイレクト URL
|
postSignOption.redirectUrl | string |
署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
|
ワークフロー ID
|
workflowId | string |
契約のルーティング パスを定義するカスタム ワークフローの ID です。 |
|
参加者セット
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
参加者セット情報 |
|
ドキュメント
|
documentsInfo.documents | array of WebhookDocument |
ドキュメントを表すオブジェクトの一覧 |
|
サポート ドキュメント
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
サポート ドキュメントの一覧。これは、契約にサポート ドキュメントがある場合のみ返される |
|
署名されたドキュメント情報
|
signedDocumentInfo.document | string |
署名されたドキュメントの Base64 エンコード文字列 |
WebhookMegaSignInfo
メガ サインの詳細情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
megasign の一意 ID |
|
件名
|
name | string |
megasign の名前 |
|
ステータス
|
status | string |
megasign の状態 |
|
CC
|
ccs | array of MegaSignCcInfo |
この megasign にコピーする 1 つ以上の電子メール アドレスの一覧です。 |
|
外部 ID
|
externalId.id | string |
送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値 |
|
最初のアラームの遅延
|
firstReminderDelay | integer |
最初のアラームを送信するまでの遅延を時間単位で指定する整数です。 |
|
ロケール
|
locale | string |
この契約に関連付けられているロケール |
|
メッセージ
|
message | string |
送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ |
|
ポスト サインのリダイレクト URL
|
postSignOption.redirectUrl | string |
署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
|
送信者の電子メール
|
senderEmail | string |
megasign 作成者の電子メール |
|
署名の種類
|
signatureType | string |
電子署名または書面で要求された署名の種類を指定します |
|
Vault は有効ですか?
|
vaultingInfo.enabled | boolean |
ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する |
|
子契約ファイル情報
|
childAgreementsInfo.fileInfo | MegaSignChildAgreementsFileInfo |
megaSign の子ごとの契約情報を含むファイル情報です。 |
WebhookWidgetInfo
ウィジェットの詳細情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
ウィジェットの一意の ID |
|
件名
|
name | string |
ウィジェットの名前 |
|
ステータス
|
status | string |
ウィジェットの状態 |
|
認証のエラー情報
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
認証のエラーの後にウィジェットの署名者に表示されるエラー ページの URL と関連するプロパティ |
|
CC
|
ccs | array of WidgetCcInfo |
このウィジェットにコピーする 1 つ以上の電子メール アドレスの一覧です。 |
|
作成日
|
createdDate | date |
ウィジェットが作成された日付 |
|
完了情報
|
completionInfo | WidgetCompletionRedirectionInfo |
ウィジェット上で希望のアクションを実行した後に、ウィジェット署名者に表示される成功ページの URL と関連するプロパティ |
|
作成者のメール
|
creatorEmail | string |
ウィジェットの作成者の電子メール |
|
Vault は有効ですか?
|
vaultingInfo.enabled | boolean |
ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する |
|
追加の参加者セット情報
|
participantSetsInfo.additionalParticipantSets | array of WidgetParticipantSetInfo |
ウィジェット署名者を除くウィジェットのすべての参加者の一覧 |
|
最初の参加者セットのロール
|
participantSetsInfo.widgetParticipantSet.role | string |
セット内のすべての参加者 (署名者、承認者など) が担うロール |
|
最初の参加者セットの順序
|
participantSetsInfo.widgetParticipantSet.order | integer |
連続する署名グループを示すインデックス (ハイブリッド ルーティング用に指定) |
|
ドキュメント
|
documentsInfo.documents | array of WidgetWebhookDocument |
ドキュメントを表すオブジェクトの一覧 |
AuthFailureWidgetRedirectionInfo
認証のエラーの後にウィジェットの署名者に表示されるエラー ページの URL と関連するプロパティ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
認証エラーのリダイレクト遅延
|
delay | integer |
ユーザーが結果ページに移動するまでの遅延時間 (秒) |
|
認証エラーのリダイレクト デフレーム
|
deframe | boolean |
デフレームが false の場合、結果ページはウィジェット フレーム内に表示 |
|
認証エラーのリダイレクト URL
|
url | string |
ウィジェットが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
WidgetCompletionRedirectionInfo
ウィジェット上で希望のアクションを実行した後に、ウィジェット署名者に表示される成功ページの URL と関連するプロパティ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
完了リダイレクト遅延
|
delay | integer |
ユーザーが結果ページに移動するまでの遅延時間 (秒) |
|
完了リダイレクト デフレーム
|
deframe | boolean |
デフレームが false の場合、結果ページはウィジェット フレーム内に表示 |
|
完了リダイレクト URL
|
url | string |
ウィジェットが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL |
WebhookParticipantSets
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メンバー情報
|
memberInfos | array of MemberInfos |
参加者メンバーに関する情報 |
|
並べ替え
|
order | integer |
署名するグループが署名する必要がある場所を示すインデックスです。 |
|
役割
|
role | string |
セット内のすべての参加者 (署名者、承認者など) が担うロール |
|
ステータス
|
status | string |
ユーザーの視点から見た契約の現状 |
|
ID
|
id | string |
参加者セットの ID |
|
件名
|
name | string |
参加者セットの名前 |
|
プライベート メッセージ
|
privateMessage | string |
セット内の参加者のプライベート メッセージ |
MegaSignChildAgreementsFileInfo
megaSign の子ごとの契約情報を含むファイル情報です。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
子契約ファイル ID
|
childAgreementsInfoFileId | string |
megaSign の既存 の childAgreementsInfo に関する情報を含むファイルの ID です。 |
WidgetWebhookDocument
ウィジェットのドキュメントに関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
ドキュメントの一意 ID |
|
件名
|
name | string |
ドキュメントの名前 |
WebhookDocument
契約のドキュメントに関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
ドキュメントの一意 ID |
|
件名
|
name | string |
ドキュメントの名前 |
WebhookSupportingDocument
サポート ドキュメントに関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
件名
|
displayLabel | string |
サポート ドキュメントの表示名 |
|
フィールド名
|
fieldName | string |
サポート ドキュメント フィールド名前 |
|
ID
|
id | string |
サポート ドキュメントを表す一意の ID |
WidgetCcInfo
ウィジェットの CC に関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
電子メール
|
string |
ウィジェットの CC 参加者の電子メール |
MegaSignCcInfo
メガ サインの CC に関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
電子メール
|
string |
megasign の CC 参加者の電子メール |
CcInfo
契約の CC に関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
電子メール
|
string |
契約の CC の電子メール |
|
|
Label
|
label | string |
ワークフローの説明で返される CC リストのラベル |
|
表示ページ
|
visiblePages | array of string |
CC に表示されるページ |
WidgetParticipantSetInfo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
役割
|
role | string |
セット内のすべての参加者 (署名者、承認者など) が担うロール |
|
ID
|
id | string |
参加者セットの一意の識別子 |
|
メンバー情報
|
memberInfos | array of MemberInfos |
参加者メンバーに関する情報 |
|
並べ替え
|
order | integer |
連続する署名グループを示すインデックス (ハイブリッド ルーティング用に指定) |
MemberInfos
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
参加者の一意の ID |
|
電子メール
|
string |
参加者の電子メール |
|
|
会社
|
company | string |
参加者の会社 |
|
件名
|
name | string |
参加者の名前 |
|
プライベート メッセージ
|
privateMessage | string |
参加者のプライベート メッセージ |
|
ステータス
|
status | string |
参加者の状態 |
LibraryDocumentCreationResponseV6
ライブラリ テンプレートを説明する JSON オブジェクト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ライブラリ テンプレート ID
|
id | string |
ライブラリ テンプレートを参照するのに使用できる一意 ID |
LibraryDocument
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ライブラリ テンプレート ID
|
id | string |
ライブラリ テンプレートを参照するために使用される一意識別子 |
|
非表示
|
hidden | boolean |
ライブラリ ドキュメントが非表示の場合は True |
|
テンプレートの種類
|
templateTypes | array of string |
1 つまたは複数のライブラリ テンプレートの種類のリスト |
|
変更日
|
modifiedDate | date |
ライブラリ テンプレートが最後に修正された日 |
|
ライブラリ テンプレート名
|
name | string |
ライブラリ パラメーターの名前 |
|
テンプレート共有モード
|
sharingMode | string |
ライブラリ テンプレートの表示スコープ |
|
作成者のメール
|
creatorEmail | string |
ライブラリ ドキュメントの作成者のメール アドレスです。 |
|
グループ ID
|
groupId | string |
ライブラリ テンプレートが属しているグループを表す一意識別子です。 |
|
ステータス
|
status | string |
ライブラリ セクションの状態 |
LibraryDocuments
ライブラリ テンプレート配列オブジェクトを含む JSON
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ページ
|
page | page |
応答内の移動のための改ページ情報 |
|
ライブラリ テンプレート リスト
|
libraryDocumentList | array of LibraryDocument |
ライブラリ テンプレート項目のリスト |
binary
これは基本的なデータ型 'バイナリ' です。
オブジェクト
’オブジェクト’ という種類です。
file
これは基本的なデータ型 'ファイル' です。