次の方法で共有

Adobe Acrobat Sign

Adobe は、世界で最も信頼されているデジタル ドキュメント 署名サービスです。 Adobe Acrobat Sign を使用すると、手動プロセスをすべてのデジタル エクスペリエンスに変換できます。 Adobe Acrobat Sign 機能をお気に入りのアプリケーションに組み込んで、契約の状態を作成、送信、監視します。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Standard 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Standard 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Standard 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Adobe Acrobat Sign のサポート
URL https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Email support@echosign.zendesk.com
コネクタ メタデータ
Publisher ADOBE INC.
Website https://acrobat.adobe.com/us/en/sign.html
プライバシー ポリシー https://www.adobe.com/privacy/policy.html
カテゴリ Website

Adobe Acrobat Sign

Adobe は、世界で最も信頼されているデジタル ドキュメント 署名サービスです。 Adobe Acrobat Sign を使用すると、手動プロセスをすべてのデジタル エクスペリエンスに変換できます。 Adobe Acrobat Sign 機能をお気に入りのアプリケーションに組み込んで、契約の状態を作成、送信、監視します。

パブリッシャー: Adobe, Inc.

[前提条件]

Adobe Acrobat Sign アカウントが必要です。

資格情報を取得する方法

N/A

コネクタの概要

コネクタ ユーザー ガイド https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

既知の問題と制限事項

N/A

一般的なエラーと解決方法

N/A

FAQ

コネクタ ユーザー ガイド https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 250 60 秒

アクション

CSV 形式で契約のフォーム フィールド データを取得する

契約の対話型フォーム フィールドに入力されたデータを取得します。
JSON 形式で契約のフォーム フィールド データを取得する

契約の対話型フォーム フィールドに入力されたデータを取得します。
すべての Web フォームの一覧を取得する

この操作により、ユーザーのすべての Web フォームの一覧がフェッチされます。
すべてのライブラリ テンプレートの一覧を取得する

この操作では、ユーザーの Adobe Acrobat Sign ライブラリにテンプレートとして格納されているすべてのドキュメントの一覧がフェッチされます。
すべてのライブラリ テンプレートの一覧を取得する (古い) [非推奨]

この操作では、ユーザーの Adobe Acrobat Sign ライブラリにテンプレートとして格納されているすべてのドキュメントの一覧がフェッチされます。
すべてのワークフローの一覧を取得する

この操作により、ユーザーのすべてのワークフローの一覧がフェッチされます。
すべての契約の一覧を取得する

この操作により、ユーザーのすべての契約の一覧がフェッチされます。
すべての契約の一覧を取得する (古い) [非推奨]

この操作により、ユーザーのすべての契約の一覧がフェッチされます。
アップロードしたドキュメントからライブラリ テンプレートを作成する

この操作により、アップロードされたドキュメントから Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 契約を送信する場合は、このテンプレートを使用します。
アップロードしたドキュメントからライブラリ テンプレートを作成する (古い) [非推奨]

この操作により、アップロードされたドキュメントから Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 契約を送信する場合は、このテンプレートを使用します。
アップロードしたドキュメントから契約を作成し、署名を送信する

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。
アップロードしたドキュメントから契約を作成し、署名を送信する (古い) [非推奨]

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。
ドキュメント URL からライブラリ テンプレートを作成する

この操作により、ドキュメント URL から Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 このテンプレートを使用して契約を送信する
ドキュメント URL からライブラリ テンプレートを作成する (古い) [非推奨]

この操作により、ドキュメント URL から Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 このテンプレートを使用して契約を送信する
ドキュメント URL から契約を作成し、署名を送信する

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。
ドキュメント URL から契約を作成し、署名を送信する (古い) [非推奨]

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。
ドキュメントをアップロードしてドキュメント ID を取得する

この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、ドキュメント ID が返されます。 このドキュメントは Adobe Acrobat Sign に一時的に格納され、ドキュメント ID は契約の作成などの追加の操作に使用できます。
ドキュメントをアップロードしてドキュメント ID を取得する (古い) [非推奨]

この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、ドキュメント ID が返されます。 このドキュメントは Adobe Acrobat Sign に一時的に格納され、ドキュメント ID は契約の作成などの追加の操作に使用できます。
ファイル コンテンツから契約を作成し、署名を送信する

この操作により、Adobe Acrobat Sign のファイルから契約が作成され、署名用に送信されます。
ユーザーが属しているすべてのグループの一覧を取得する

この操作により、ユーザーが属するすべてのグループの一覧がフェッチされます。
ライブラリ テンプレートから契約を作成し、署名を送信する

この操作では、ユーザーの Adobe Acrobat Sign ライブラリに格納されているテンプレートから契約が作成され、署名用に送信されます。
ライブラリ テンプレートから契約を作成し、署名を送信する (古い) [非推奨]

この操作では、ユーザーの Adobe Acrobat Sign ライブラリに格納されているテンプレートから契約が作成され、署名用に送信されます。
ワークフローから契約を作成し、署名を送信する

この操作により、Adobe Acrobat Sign のワークフローから契約が作成され、署名用に送信されます。
ワークフローの詳細情報を取得する

この操作により、ワークフローに関する詳細な情報がフェッチされます。
契約からすべてのドキュメント ID の一覧を取得する

この操作により、契約のすべてのドキュメントとサポート ドキュメントの ID がフェッチされます。
契約からすべてのドキュメント ID の一覧を取得する [非推奨]

このアクションは非推奨になりました。 代わりに 、契約からすべてのドキュメント ID の一覧を取得するを 使用してください。

この操作により、契約のすべてのドキュメントとサポート ドキュメントの ID がフェッチされます。
契約からドキュメントを取得する

この操作は、契約の特定のドキュメントのファイル ストリームをフェッチします。
契約からドキュメントを取得する [非推奨]

このアクションは非推奨になりました。 代わりに、 契約からドキュメントを取得するを 使用してください。

この操作は、契約の特定のドキュメントのファイル ストリームをフェッチします。
契約のフォーム フィールド データを取得する (古い) [非推奨]

契約の対話型フォーム フィールドに入力されたデータを取得します。
契約の状態を取得する

この操作では、状態など、契約のすべての現在の情報がフェッチされます。
契約の状態を取得する [非推奨]

このアクションは非推奨になりました。 代わりに、[ 契約の状態を取得する] を 使用してください。

この操作では、状態など、契約のすべての現在の情報がフェッチされます。
契約の監査証跡の PDF を取得する

この操作により、契約監査証跡の PDF ファイル ストリームがフェッチされます。 ファイル ストリームは、ファイル拡張子で終わるファイル名 .pdf 格納する必要があることに注意してください。
契約を取り消す

パス内の agreementId によって識別される契約を取り消します。
契約ビューの URL を取得する

契約の最新の状態ビュー URL を取得します。
検索条件に基づいてすべての契約の一覧を取得する

この操作は、ワークフロー ID などの条件で契約を検索します。
署名 URL を取得する

この操作では、契約の現在の署名者の電子署名ページの URL を取得します。
署名済み契約の PDF を取得する

この操作により、結合または署名された契約の PDF ファイル ストリームがフェッチされます。 ファイル ストリームは、ファイル拡張子で終わるファイル名 .pdf 格納する必要があることに注意してください。
署名済み契約の PDF を取得する [非推奨]

このアクションは非推奨になりました。 代わりに 、署名済み契約の PDF を取得するを 使用してください。

この操作により、結合または署名された契約の PDF ファイル ストリームがフェッチされます。 ファイル ストリームは、ファイル拡張子で終わるファイル名 .pdf 格納する必要があることに注意してください。

CSV 形式で契約のフォーム フィールド データを取得する

操作 ID:
GetAgreementFormFieldData_V2

契約の対話型フォーム フィールドに入力されたデータを取得します。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

情報が必要な契約の契約 ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

フォーム データの内容

フォーム データコンテンツ
binary

JSON 形式で契約のフォーム フィールド データを取得する

操作 ID:
GetAgreementFormFieldData_V3

契約の対話型フォーム フィールドに入力されたデータを取得します。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

情報が必要な契約の契約 ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

フォーム データの内容

フォーム データコンテンツ
object

すべての Web フォームの一覧を取得する

操作 ID:
GetAllWebForms

この操作により、ユーザーのすべての Web フォームの一覧がフェッチされます。

パラメーター

名前 キー 必須 型 説明
Cursor
 cursor string

ページ間を移動するために使用されます。 指定しない場合は、最初のページを返します。
ページ サイズ
 pageSize integer

応答ページ内の項目の数。 既定では 100。最大: 10000
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ユーザー Web フォーム配列オブジェクトを含む JSON

Body
userWidgetListV6

すべてのライブラリ テンプレートの一覧を取得する

操作 ID:
GetLibraryDocuments_V2

この操作では、ユーザーの Adobe Acrobat Sign ライブラリにテンプレートとして格納されているすべてのドキュメントの一覧がフェッチされます。

パラメーター

名前 キー 必須 型 説明
Cursor
 cursor string

ページ間を移動するために使用されます。 指定しない場合は、最初のページを返します。
ページ サイズ
 pageSize integer

応答ページ内の項目の数。 既定では 100。最大: 10000
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ライブラリ テンプレート配列オブジェクトを含む JSON

Body
LibraryDocuments

すべてのライブラリ テンプレートの一覧を取得する (古い) [非推奨]

操作 ID:
GetLibraryDocuments

この操作では、ユーザーの Adobe Acrobat Sign ライブラリにテンプレートとして格納されているすべてのドキュメントの一覧がフェッチされます。

戻り値

ライブラリ テンプレート配列オブジェクトを含む JSON

Body
DocumentLibraryItems

すべてのワークフローの一覧を取得する

操作 ID:
GetAllWorkflows

この操作により、ユーザーのすべてのワークフローの一覧がフェッチされます。

パラメーター

名前 キー 必須 型 説明
下書きワークフローを含める
 includeDraftWorkflows boolean

下書きワークフローを含める
非アクティブなワークフローを含める
 includeInactiveWorkflows boolean

非アクティブなワークフローを含める
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ユーザー ワークフロー配列オブジェクトを含む JSON

Body
userWorkflowListV6

すべての契約の一覧を取得する

操作 ID:
GetAllAgreements_V2

この操作により、ユーザーのすべての契約の一覧がフェッチされます。

パラメーター

名前 キー 必須 型 説明
Cursor
 cursor string

ページ間を移動するために使用されます。 指定しない場合は、最初のページを返します。
ページ サイズ
 pageSize integer

応答ページ内の項目の数。 既定では 100。最大: 10000
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ユーザー契約配列オブジェクトを含む JSON

Body
userAgreementListV6

すべての契約の一覧を取得する (古い) [非推奨]

操作 ID:
GetAllAgreements

この操作により、ユーザーのすべての契約の一覧がフェッチされます。

戻り値

ユーザー契約配列オブジェクトを含む JSON

Body
UserAgreements

アップロードしたドキュメントからライブラリ テンプレートを作成する

操作 ID:
CreateLibraryDocumentById_V2

この操作により、アップロードされたドキュメントから Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 契約を送信する場合は、このテンプレートを使用します。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
テンプレート名
 name True string

テンプレートを識別するために使用される契約名
テンプレートの種類
 templateTypes True array of string

1 つ以上のライブラリ テンプレートの種類の一覧
共有モード
 sharingMode True string

このライブラリ ドキュメントにアクセスできるユーザーを指定します
ID
 transientDocumentId True string

一時的なドキュメントをアップロードして受信したドキュメント ID
テンプレートの状態
 state True string

ライブラリ ドキュメントの状態。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ライブラリ テンプレートを記述する JSON オブジェクト

Body
LibraryDocumentCreationResponseV6

アップロードしたドキュメントからライブラリ テンプレートを作成する (古い) [非推奨]

操作 ID:
CreateLibraryDocumentById

この操作により、アップロードされたドキュメントから Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 契約を送信する場合は、このテンプレートを使用します。

パラメーター

名前 キー 必須 型 説明
テンプレート名
 name True string

テンプレートを識別するために使用される契約名
テンプレートの種類
 libraryTemplateTypes True string

1 つ以上のライブラリ テンプレートの種類の一覧
共有する
 librarySharingMode True string

このライブラリ ドキュメントにアクセスできるユーザーを指定します
ドキュメント ID
 transientDocumentId True string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (2)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (3)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (4)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (5)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (6)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (7)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (8)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (9)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (10)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID

戻り値

ライブラリ テンプレートを記述する JSON オブジェクト

Body
LibraryDocumentCreationResponse

アップロードしたドキュメントから契約を作成し、署名を送信する

操作 ID:
CreateAgreementById_V2

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
契約名
 name True string

契約の名前
ID
 transientDocumentId True string

一時的なドキュメントをアップロードして受信したドキュメント ID
署名の種類
 signatureType True string

要求する署名の種類 (電子署名または書き込み)
Email
 email True string

参加者の電子メール
Authentication
 authenticationMethod string

既定の認証: 電子メール (なし)
パスワード
 password string

参加者に必要なパスワード
国番号
 countryCode string

ドキュメントの表示と署名に必要な受信者の電話の国コード
電話番号。
 phone string

契約の表示と署名に必要な受信者の電話番号
プロバイダー ID
 providerId string

デジタル ID ゲートウェイ プロバイダー ID。
注文
 order True integer

1 から始まるインデックス。署名グループが署名する必要がある位置を示します。
Role
 role True string

参加者セットの現在のロール (署名者、承認者など)。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
送信の種類
 sendType string

元のユーザーが契約を送信するために使用するエクスペリエンスの種類
Email
 email string

契約の CC の電子メール
有効期限
 expirationTime string

契約の有効期限が切れる時間。 例: 2020-12-31T23:59:00Z
外部 ID
 externalId string

システムからの任意の値
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
名前
 fieldName string

フィールドの名前
価値
 defaultValue string

フィールドの既定値
リダイレクト遅延
 redirectDelay string

ユーザーが成功ページに移動するまでの遅延 (秒単位)。
リダイレクト URL
 redirectUrl string

署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com
初期メール
 initEmails string

契約開始イベントの通知メールを制御します。
State
 state True string

契約が成立する必要がある状態。

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponseV6

アップロードしたドキュメントから契約を作成し、署名を送信する (古い) [非推奨]

操作 ID:
CreateAgreementById

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
契約名
 name True string

契約の名前
ドキュメント ID
 transientDocumentId True string

ドキュメントをアップロードして受信したドキュメント ID
署名の種類
 signatureType True string

要求する署名の種類 - E 署名または書き込み
受信者の電子メール
 email True string

受信者の電子メール
受信者の署名順序
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール
 recipientSetRole True string

受信者の役割を指定する
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
期限までの日数
 daysUntilSigningDeadline integer

ドキュメントの有効期限が切れるまでの日数
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
ドキュメント ID (2)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (3)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (4)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (5)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (6)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (7)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (8)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (9)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
ドキュメント ID (10)
 transientDocumentId string

ドキュメントをアップロードして受信したドキュメント ID
受信者の電子メール (2)
 email True string

受信者の電子メール
受信者の署名順序 (2)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (2)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (3)
 email True string

受信者の電子メール
受信者の署名順序 (3)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (3)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (4)
 email True string

受信者の電子メール
受信者の署名順序 (4)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (4)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (5)
 email True string

受信者の電子メール
受信者の署名順序 (5)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (5)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (6)
 email True string

受信者の電子メール
受信者の署名順序 (6)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (6)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (7)
 email True string

受信者の電子メール
受信者の署名順序 (7)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (7)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (8)
 email True string

受信者の電子メール
受信者の署名順序 (8)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (8)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (9)
 email True string

受信者の電子メール
受信者の署名順序 (9)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (9)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (10)
 email True string

受信者の電子メール
受信者の署名順序 (10)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (10)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (11)
 email True string

受信者の電子メール
受信者の署名順序 (11)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (11)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (12)
 email True string

受信者の電子メール
受信者の署名順序 (12)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (12)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (13)
 email True string

受信者の電子メール
受信者の署名順序 (13)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (13)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (14)
 email True string

受信者の電子メール
受信者の署名順序 (14)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (14)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (15)
 email True string

受信者の電子メール
受信者の署名順序 (15)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (15)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (16)
 email True string

受信者の電子メール
受信者の署名順序 (16)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (16)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (17)
 email True string

受信者の電子メール
受信者の署名順序 (17)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (17)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (18)
 email True string

受信者の電子メール
受信者の署名順序 (18)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (18)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (19)
 email True string

受信者の電子メール
受信者の署名順序 (19)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (19)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (20)
 email True string

受信者の電子メール
受信者の署名順序 (20)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (20)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (21)
 email True string

受信者の電子メール
受信者の署名順序 (21)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (21)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (22)
 email True string

受信者の電子メール
受信者の署名順序 (22)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (22)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (23)
 email True string

受信者の電子メール
受信者の署名順序 (23)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (23)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (24)
 email True string

受信者の電子メール
受信者の署名順序 (24)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (24)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (25)
 email True string

受信者の電子メール
受信者の署名順序 (25)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (25)
 recipientSetRole True string

受信者の役割を指定する
フォーム フィールド名 (1)
 fieldName string

フィールドの名前
フォーム フィールド値 (1)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (2)
 fieldName string

フィールドの名前
フォーム フィールド値 (2)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (3)
 fieldName string

フィールドの名前
フォーム フィールド値 (3)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (4)
 fieldName string

フィールドの名前
フォーム フィールド値 (4)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (5)
 fieldName string

フィールドの名前
フォーム フィールド値 (5)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (6)
 fieldName string

フィールドの名前
フォーム フィールド値 (6)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (7)
 fieldName string

フィールドの名前
フォーム フィールド値 (7)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (8)
 fieldName string

フィールドの名前
フォーム フィールド値 (8)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (9)
 fieldName string

フィールドの名前
フォーム フィールド値 (9)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (10)
 fieldName string

フィールドの名前
フォーム フィールド値 (10)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (11)
 fieldName string

フィールドの名前
フォーム フィールド値 (11)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (12)
 fieldName string

フィールドの名前
フォーム フィールド値 (12)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (13)
 fieldName string

フィールドの名前
フォーム フィールド値 (13)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (14)
 fieldName string

フィールドの名前
フォーム フィールド値 (14)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (15)
 fieldName string

フィールドの名前
フォーム フィールド値 (15)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (16)
 fieldName string

フィールドの名前
フォーム フィールド値 (16)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (17)
 fieldName string

フィールドの名前
フォーム フィールド値 (17)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (18)
 fieldName string

フィールドの名前
フォーム フィールド値 (18)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (19)
 fieldName string

フィールドの名前
フォーム フィールド値 (19)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (20)
 fieldName string

フィールドの名前
フォーム フィールド値 (20)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (21)
 fieldName string

フィールドの名前
フォーム フィールド値 (21)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (22)
 fieldName string

フィールドの名前
フォーム フィールド値 (22)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (23)
 fieldName string

フィールドの名前
フォーム フィールド値 (23)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (24)
 fieldName string

フィールドの名前
フォーム フィールド値 (24)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (25)
 fieldName string

フィールドの名前
フォーム フィールド値 (25)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (26)
 fieldName string

フィールドの名前
フォーム フィールド値 (26)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (27)
 fieldName string

フィールドの名前
フォーム フィールド値 (27)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (28)
 fieldName string

フィールドの名前
フォーム フィールド値 (28)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (29)
 fieldName string

フィールドの名前
フォーム フィールド値 (29)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (30)
 fieldName string

フィールドの名前
フォーム フィールド値 (30)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (31)
 fieldName string

フィールドの名前
フォーム フィールド値 (31)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (32)
 fieldName string

フィールドの名前
フォーム フィールド値 (32)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (33)
 fieldName string

フィールドの名前
フォーム フィールド値 (33)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (34)
 fieldName string

フィールドの名前
フォーム フィールド値 (34)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (35)
 fieldName string

フィールドの名前
フォーム フィールド値 (35)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (36)
 fieldName string

フィールドの名前
フォーム フィールド値 (36)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (37)
 fieldName string

フィールドの名前
フォーム フィールド値 (37)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (38)
 fieldName string

フィールドの名前
フォーム フィールド値 (38)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (39)
 fieldName string

フィールドの名前
フォーム フィールド値 (39)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (40)
 fieldName string

フィールドの名前
フォーム フィールド値 (40)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (41)
 fieldName string

フィールドの名前
フォーム フィールド値 (41)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (42)
 fieldName string

フィールドの名前
フォーム フィールド値 (42)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (43)
 fieldName string

フィールドの名前
フォーム フィールド値 (43)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (44)
 fieldName string

フィールドの名前
フォーム フィールド値 (44)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (45)
 fieldName string

フィールドの名前
フォーム フィールド値 (45)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (46)
 fieldName string

フィールドの名前
フォーム フィールド値 (46)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (47)
 fieldName string

フィールドの名前
フォーム フィールド値 (47)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (48)
 fieldName string

フィールドの名前
フォーム フィールド値 (48)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (49)
 fieldName string

フィールドの名前
フォーム フィールド値 (49)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (50)
 fieldName string

フィールドの名前
フォーム フィールド値 (50)
 defaultValue string

フィールドの既定値

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponse

ドキュメント URL からライブラリ テンプレートを作成する

操作 ID:
CreateLibraryDocumentByUrl_V2

この操作により、ドキュメント URL から Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 このテンプレートを使用して契約を送信する

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
テンプレート名
 name True string

テンプレートを識別するために使用される契約名
テンプレートの種類
 templateTypes True array of string

1 つ以上のライブラリ テンプレートの種類の一覧
共有モード
 sharingMode True string

このライブラリ ドキュメントにアクセスできるユーザーを指定します
URL
 url True string

生のファイル コンテンツを取得するためのパブリックにアクセス可能な URL
名前
 name True string

送信されるドキュメントの元のシステム ファイル名
タイプ
 mimeType True string

参照されるファイルの mime の種類 (application/pdf など)
テンプレートの状態
 state True string

ライブラリ ドキュメントの状態。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ライブラリ テンプレートを記述する JSON オブジェクト

Body
LibraryDocumentCreationResponseV6

ドキュメント URL からライブラリ テンプレートを作成する (古い) [非推奨]

操作 ID:
CreateLibraryDocumentByUrl

この操作により、ドキュメント URL から Adobe Acrobat Sign ライブラリにテンプレートが作成されます。 このテンプレートを使用して契約を送信する

パラメーター

名前 キー 必須 型 説明
テンプレート名
 name True string

テンプレートを識別するために使用される契約名
テンプレートの種類
 libraryTemplateTypes True string

1 つ以上のライブラリ テンプレートの種類の一覧
共有する
 librarySharingMode True string

このライブラリ ドキュメントにアクセスできるユーザーを指定します
URL
 url True string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前
 name True string

参照先ドキュメントの名前 (拡張子付き)
URL (2)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (2)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (3)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (3)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (4)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (4)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (5)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (5)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (6)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (6)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (7)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (7)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (8)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (8)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (9)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (9)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (10)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (10)
 name string

参照先ドキュメントの名前 (拡張子付き)

戻り値

ライブラリ テンプレートを記述する JSON オブジェクト

Body
LibraryDocumentCreationResponse

ドキュメント URL から契約を作成し、署名を送信する

操作 ID:
CreateAgreementByUrl_V2

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
契約名
 name True string

契約の名前
URL
 url True string

生のファイル コンテンツを取得するためのパブリックにアクセス可能な URL
名前
 name True string

送信されるドキュメントの元のシステム ファイル名
タイプ
 mimeType True string

参照されるファイルの mime の種類 (application/pdf など)
署名の種類
 signatureType True string

要求された署名の種類 (E 署名または書き込み) を指定します
Email
 email True string

参加者の電子メール
Authentication
 authenticationMethod string

既定の認証: 電子メール (なし)
パスワード
 password string

参加者に必要なパスワード
国番号
 countryCode string

ドキュメントの表示と署名に必要な受信者の電話の国コード
電話番号。
 phone string

契約の表示と署名に必要な受信者の電話番号
プロバイダー ID
 providerId string

デジタル ID ゲートウェイ プロバイダー ID。
注文
 order True integer

1 から始まるインデックス。署名グループが署名する必要がある位置を示します。
Role
 role True string

参加者セットの現在のロール (署名者、承認者など)。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
送信の種類
 sendType string

元のユーザーが契約を送信するために使用するエクスペリエンスの種類
Email
 email string

契約の CC の電子メール
有効期限
 expirationTime string

契約の有効期限が切れる時間。 例: 2020-12-31T23:59:00Z
外部 ID
 externalId string

システムからの任意の値
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
名前
 fieldName string

フィールドの名前
価値
 defaultValue string

フィールドの既定値
リダイレクト遅延
 redirectDelay string

ユーザーが成功ページに移動するまでの遅延 (秒単位)。
リダイレクト URL
 redirectUrl string

署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com
初期メール
 initEmails string

契約開始イベントの通知メールを制御します。
State
 state True string

契約が成立する必要がある状態。

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponseV6

ドキュメント URL から契約を作成し、署名を送信する (古い) [非推奨]

操作 ID:
CreateAgreementByUrl

この操作により、Adobe Acrobat Sign にアップロードされたドキュメントから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
契約名
 name True string

契約の名前
URL
 url True string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前
 name True string

参照先ドキュメントの名前 (拡張子付き)
署名の種類
 signatureType True string

要求する署名の種類 - E 署名または書き込み
受信者の電子メール
 email True string

受信者の電子メール
受信者の署名順序
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール
 recipientSetRole True string

受信者の役割を指定する
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
期限までの日数
 daysUntilSigningDeadline integer

ドキュメントの有効期限が切れるまでの日数
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
URL (2)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (2)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (3)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (3)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (4)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (4)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (5)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (5)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (6)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (6)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (7)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (7)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (8)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (8)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (9)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (9)
 name string

参照先ドキュメントの名前 (拡張子付き)
URL (10)
 url string

ドキュメントを取得するためのパブリックにアクセスできる URL
名前 (10)
 name string

参照先ドキュメントの名前 (拡張子付き)
受信者の電子メール (2)
 email True string

受信者の電子メール
受信者の署名順序 (2)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (2)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (3)
 email True string

受信者の電子メール
受信者の署名順序 (3)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (3)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (4)
 email True string

受信者の電子メール
受信者の署名順序 (4)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (4)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (5)
 email True string

受信者の電子メール
受信者の署名順序 (5)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (5)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (6)
 email True string

受信者の電子メール
受信者の署名順序 (6)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (6)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (7)
 email True string

受信者の電子メール
受信者の署名順序 (7)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (7)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (8)
 email True string

受信者の電子メール
受信者の署名順序 (8)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (8)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (9)
 email True string

受信者の電子メール
受信者の署名順序 (9)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (9)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (10)
 email True string

受信者の電子メール
受信者の署名順序 (10)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (10)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (11)
 email True string

受信者の電子メール
受信者の署名順序 (11)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (11)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (12)
 email True string

受信者の電子メール
受信者の署名順序 (12)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (12)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (13)
 email True string

受信者の電子メール
受信者の署名順序 (13)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (13)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (14)
 email True string

受信者の電子メール
受信者の署名順序 (14)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (14)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (15)
 email True string

受信者の電子メール
受信者の署名順序 (15)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (15)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (16)
 email True string

受信者の電子メール
受信者の署名順序 (16)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (16)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (17)
 email True string

受信者の電子メール
受信者の署名順序 (17)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (17)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (18)
 email True string

受信者の電子メール
受信者の署名順序 (18)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (18)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (19)
 email True string

受信者の電子メール
受信者の署名順序 (19)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (19)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (20)
 email True string

受信者の電子メール
受信者の署名順序 (20)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (20)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (21)
 email True string

受信者の電子メール
受信者の署名順序 (21)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (21)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (22)
 email True string

受信者の電子メール
受信者の署名順序 (22)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (22)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (23)
 email True string

受信者の電子メール
受信者の署名順序 (23)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (23)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (24)
 email True string

受信者の電子メール
受信者の署名順序 (24)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (24)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (25)
 email True string

受信者の電子メール
受信者の署名順序 (25)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (25)
 recipientSetRole True string

受信者の役割を指定する
フォーム フィールド名 (1)
 fieldName string

フィールドの名前
フォーム フィールド値 (1)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (2)
 fieldName string

フィールドの名前
フォーム フィールド値 (2)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (3)
 fieldName string

フィールドの名前
フォーム フィールド値 (3)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (4)
 fieldName string

フィールドの名前
フォーム フィールド値 (4)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (5)
 fieldName string

フィールドの名前
フォーム フィールド値 (5)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (6)
 fieldName string

フィールドの名前
フォーム フィールド値 (6)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (7)
 fieldName string

フィールドの名前
フォーム フィールド値 (7)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (8)
 fieldName string

フィールドの名前
フォーム フィールド値 (8)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (9)
 fieldName string

フィールドの名前
フォーム フィールド値 (9)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (10)
 fieldName string

フィールドの名前
フォーム フィールド値 (10)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (11)
 fieldName string

フィールドの名前
フォーム フィールド値 (11)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (12)
 fieldName string

フィールドの名前
フォーム フィールド値 (12)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (13)
 fieldName string

フィールドの名前
フォーム フィールド値 (13)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (14)
 fieldName string

フィールドの名前
フォーム フィールド値 (14)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (15)
 fieldName string

フィールドの名前
フォーム フィールド値 (15)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (16)
 fieldName string

フィールドの名前
フォーム フィールド値 (16)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (17)
 fieldName string

フィールドの名前
フォーム フィールド値 (17)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (18)
 fieldName string

フィールドの名前
フォーム フィールド値 (18)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (19)
 fieldName string

フィールドの名前
フォーム フィールド値 (19)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (20)
 fieldName string

フィールドの名前
フォーム フィールド値 (20)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (21)
 fieldName string

フィールドの名前
フォーム フィールド値 (21)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (22)
 fieldName string

フィールドの名前
フォーム フィールド値 (22)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (23)
 fieldName string

フィールドの名前
フォーム フィールド値 (23)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (24)
 fieldName string

フィールドの名前
フォーム フィールド値 (24)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (25)
 fieldName string

フィールドの名前
フォーム フィールド値 (25)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (26)
 fieldName string

フィールドの名前
フォーム フィールド値 (26)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (27)
 fieldName string

フィールドの名前
フォーム フィールド値 (27)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (28)
 fieldName string

フィールドの名前
フォーム フィールド値 (28)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (29)
 fieldName string

フィールドの名前
フォーム フィールド値 (29)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (30)
 fieldName string

フィールドの名前
フォーム フィールド値 (30)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (31)
 fieldName string

フィールドの名前
フォーム フィールド値 (31)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (32)
 fieldName string

フィールドの名前
フォーム フィールド値 (32)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (33)
 fieldName string

フィールドの名前
フォーム フィールド値 (33)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (34)
 fieldName string

フィールドの名前
フォーム フィールド値 (34)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (35)
 fieldName string

フィールドの名前
フォーム フィールド値 (35)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (36)
 fieldName string

フィールドの名前
フォーム フィールド値 (36)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (37)
 fieldName string

フィールドの名前
フォーム フィールド値 (37)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (38)
 fieldName string

フィールドの名前
フォーム フィールド値 (38)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (39)
 fieldName string

フィールドの名前
フォーム フィールド値 (39)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (40)
 fieldName string

フィールドの名前
フォーム フィールド値 (40)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (41)
 fieldName string

フィールドの名前
フォーム フィールド値 (41)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (42)
 fieldName string

フィールドの名前
フォーム フィールド値 (42)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (43)
 fieldName string

フィールドの名前
フォーム フィールド値 (43)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (44)
 fieldName string

フィールドの名前
フォーム フィールド値 (44)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (45)
 fieldName string

フィールドの名前
フォーム フィールド値 (45)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (46)
 fieldName string

フィールドの名前
フォーム フィールド値 (46)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (47)
 fieldName string

フィールドの名前
フォーム フィールド値 (47)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (48)
 fieldName string

フィールドの名前
フォーム フィールド値 (48)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (49)
 fieldName string

フィールドの名前
フォーム フィールド値 (49)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (50)
 fieldName string

フィールドの名前
フォーム フィールド値 (50)
 defaultValue string

フィールドの既定値

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponse

ドキュメントをアップロードしてドキュメント ID を取得する

操作 ID:
CreateTransientDocument_V2

この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、ドキュメント ID が返されます。 このドキュメントは Adobe Acrobat Sign に一時的に格納され、ドキュメント ID は契約の作成などの追加の操作に使用できます。

パラメーター

名前 キー 必須 型 説明
ファイル名
 File-Name True string

アップロードするドキュメントの名前 (拡張子付き)
ファイル コンテンツ
 File True contentOnly

アップロードするドキュメントのファイル ストリーム
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

アップロードされたドキュメントの ID を含む JSON

Body
TransientDocumentResponse

ドキュメントをアップロードしてドキュメント ID を取得する (古い) [非推奨]

操作 ID:
CreateTransientDocument

この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、ドキュメント ID が返されます。 このドキュメントは Adobe Acrobat Sign に一時的に格納され、ドキュメント ID は契約の作成などの追加の操作に使用できます。

パラメーター

名前 キー 必須 型 説明
ファイル名
 File-Name True string

アップロードするドキュメントの名前 (拡張子付き)
ファイル コンテンツ
 File True contentOnly

アップロードするドキュメントのファイル ストリーム

戻り値

アップロードされたドキュメントの ID を含む JSON

Body
TransientDocumentResponse

ファイル コンテンツから契約を作成し、署名を送信する

操作 ID:
CreateAgreementByFileStream

この操作により、Adobe Acrobat Sign のファイルから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
契約名
 name True string

契約の名前
名前
 fileName True string

アップロードするドキュメントの名前 (拡張子付き)
Content
 formData True byte

アップロードするドキュメントのファイル ストリーム
署名の種類
 signatureType True string

要求する署名の種類 (電子署名または書き込み)
Email
 email True string

参加者の電子メール
Authentication
 authenticationMethod string

既定の認証: 電子メール (なし)
パスワード
 password string

参加者に必要なパスワード
国番号
 countryCode string

ドキュメントの表示と署名に必要な受信者の電話の国コード
電話番号。
 phone string

契約の表示と署名に必要な受信者の電話番号
プロバイダー ID
 providerId string

デジタル ID ゲートウェイ プロバイダー ID。
注文
 order True integer

1 から始まるインデックス。署名グループが署名する必要がある位置を示します。
Role
 role True string

参加者セットの現在のロール (署名者、承認者など)。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
送信の種類
 sendType string

元のユーザーが契約を送信するために使用するエクスペリエンスの種類
Email
 email string

契約の CC の電子メール
有効期限
 expirationTime string

契約の有効期限が切れる時間。 例: 2020-12-31T23:59:00Z
外部 ID
 externalId string

システムからの任意の値
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
名前
 fieldName string

フィールドの名前
価値
 defaultValue string

フィールドの既定値
リダイレクト遅延
 redirectDelay string

ユーザーが成功ページに移動するまでの遅延 (秒単位)。
リダイレクト URL
 redirectUrl string

署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com
初期メール
 initEmails string

契約開始イベントの通知メールを制御します。
State
 state True string

契約が成立する必要がある状態。

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponseV6

ユーザーが属しているすべてのグループの一覧を取得する

操作 ID:
GetAllUserGroups

この操作により、ユーザーが属するすべてのグループの一覧がフェッチされます。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
ユーザーID
 userId True string

承認されたユーザーの結果を取得するために、ユーザー ID を引用符なしで 'me' に置き換えることができます。

戻り値

特定のユーザーのグループの一覧を含む JSON

Body
UserGroupsInfoV6

ライブラリ テンプレートから契約を作成し、署名を送信する

操作 ID:
CreateAgreementByTemplate_V2

この操作では、ユーザーの Adobe Acrobat Sign ライブラリに格納されているテンプレートから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
契約名
 name True string

契約の名前
Template
 libraryDocumentId True string

ライブラリに保存されているテンプレートからドキュメントを選択する
署名の種類
 signatureType True string

要求する署名の種類 (電子署名または書き込み)
Email
 email True string

参加者の電子メール
Authentication
 authenticationMethod string

既定の認証: 電子メール (なし)
パスワード
 password string

参加者に必要なパスワード
国番号
 countryCode string

ドキュメントの表示と署名に必要な受信者の電話の国コード
電話番号。
 phone string

契約の表示と署名に必要な受信者の電話番号
プロバイダー ID
 providerId string

デジタル ID ゲートウェイ プロバイダー ID。
注文
 order True integer

1 から始まるインデックス。署名グループが署名する必要がある位置を示します。
Role
 role True string

参加者セットの現在のロール (署名者、承認者など)。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
送信の種類
 sendType string

元のユーザーが契約を送信するために使用するエクスペリエンスの種類
Email
 email string

契約の CC の電子メール
有効期限
 expirationTime string

契約の有効期限が切れる時間。 例: 2020-12-31T23:59:00Z
外部 ID
 externalId string

システムからの任意の値
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
名前
 fieldName string

フィールドの名前
価値
 defaultValue string

フィールドの既定値
リダイレクト遅延
 redirectDelay string

ユーザーが成功ページに移動するまでの遅延 (秒単位)。
リダイレクト URL
 redirectUrl string

署名プロセスの完了後にリダイレクトする URL (例: https://adobe.com
初期メール
 initEmails string

契約開始イベントの通知メールを制御します。
State
 state True string

契約が成立する必要がある状態。

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponseV6

ライブラリ テンプレートから契約を作成し、署名を送信する (古い) [非推奨]

操作 ID:
CreateAgreementByTemplate

この操作では、ユーザーの Adobe Acrobat Sign ライブラリに格納されているテンプレートから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
契約名
 name True string

契約の名前
ドキュメント ライブラリ テンプレート
 libraryDocumentId True string

ライブラリに保存されているテンプレートからドキュメントを選択する
署名の種類
 signatureType True string

要求する署名の種類 - E 署名または書き込み
受信者の電子メール
 email True string

受信者の電子メール
受信者の署名順序
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール
 recipientSetRole True string

受信者の役割を指定する
メッセージ
 message string

アクションを要求する受信者への省略可能なメッセージ
期限までの日数
 daysUntilSigningDeadline integer

ドキュメントの有効期限が切れるまでの日数
アラームの頻度
 reminderFrequency string

リマインダーを送信する頻度はどのくらいですか?
ドキュメント パスワード
 openPassword string

署名済み契約 PDF の暗号化に使用する必要があるパスワード
ドキュメント ライブラリ テンプレート (2)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (3)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (4)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (5)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (6)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (7)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (8)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (9)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
ドキュメント ライブラリ テンプレート (10)
 libraryDocumentId string

ライブラリに保存されているテンプレートからドキュメントを選択する
受信者の電子メール (2)
 email True string

受信者の電子メール
受信者の署名順序 (2)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (2)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (3)
 email True string

受信者の電子メール
受信者の署名順序 (3)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (3)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (4)
 email True string

受信者の電子メール
受信者の署名順序 (4)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (4)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (5)
 email True string

受信者の電子メール
受信者の署名順序 (5)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (5)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (6)
 email True string

受信者の電子メール
受信者の署名順序 (6)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (6)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (7)
 email True string

受信者の電子メール
受信者の署名順序 (7)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (7)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (8)
 email True string

受信者の電子メール
受信者の署名順序 (8)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (8)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (9)
 email True string

受信者の電子メール
受信者の署名順序 (9)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (9)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (10)
 email True string

受信者の電子メール
受信者の署名順序 (10)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (10)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (11)
 email True string

受信者の電子メール
受信者の署名順序 (11)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (11)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (12)
 email True string

受信者の電子メール
受信者の署名順序 (12)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (12)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (13)
 email True string

受信者の電子メール
受信者の署名順序 (13)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (13)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (14)
 email True string

受信者の電子メール
受信者の署名順序 (14)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (14)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (15)
 email True string

受信者の電子メール
受信者の署名順序 (15)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (15)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (16)
 email True string

受信者の電子メール
受信者の署名順序 (16)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (16)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (17)
 email True string

受信者の電子メール
受信者の署名順序 (17)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (17)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (18)
 email True string

受信者の電子メール
受信者の署名順序 (18)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (18)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (19)
 email True string

受信者の電子メール
受信者の署名順序 (19)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (19)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (20)
 email True string

受信者の電子メール
受信者の署名順序 (20)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (20)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (21)
 email True string

受信者の電子メール
受信者の署名順序 (21)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (21)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (22)
 email True string

受信者の電子メール
受信者の署名順序 (22)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (22)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (23)
 email True string

受信者の電子メール
受信者の署名順序 (23)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (23)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (24)
 email True string

受信者の電子メール
受信者の署名順序 (24)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (24)
 recipientSetRole True string

受信者の役割を指定する
受信者の電子メール (25)
 email True string

受信者の電子メール
受信者の署名順序 (25)
 signingOrder True integer

この受信者が署名する順序を示す 1 から始まるインデックス
受信者ロール (25)
 recipientSetRole True string

受信者の役割を指定する
フォーム フィールド名 (1)
 fieldName string

フィールドの名前
フォーム フィールド値 (1)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (2)
 fieldName string

フィールドの名前
フォーム フィールド値 (2)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (3)
 fieldName string

フィールドの名前
フォーム フィールド値 (3)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (4)
 fieldName string

フィールドの名前
フォーム フィールド値 (4)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (5)
 fieldName string

フィールドの名前
フォーム フィールド値 (5)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (6)
 fieldName string

フィールドの名前
フォーム フィールド値 (6)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (7)
 fieldName string

フィールドの名前
フォーム フィールド値 (7)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (8)
 fieldName string

フィールドの名前
フォーム フィールド値 (8)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (9)
 fieldName string

フィールドの名前
フォーム フィールド値 (9)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (10)
 fieldName string

フィールドの名前
フォーム フィールド値 (10)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (11)
 fieldName string

フィールドの名前
フォーム フィールド値 (11)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (12)
 fieldName string

フィールドの名前
フォーム フィールド値 (12)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (13)
 fieldName string

フィールドの名前
フォーム フィールド値 (13)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (14)
 fieldName string

フィールドの名前
フォーム フィールド値 (14)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (15)
 fieldName string

フィールドの名前
フォーム フィールド値 (15)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (16)
 fieldName string

フィールドの名前
フォーム フィールド値 (16)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (17)
 fieldName string

フィールドの名前
フォーム フィールド値 (17)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (18)
 fieldName string

フィールドの名前
フォーム フィールド値 (18)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (19)
 fieldName string

フィールドの名前
フォーム フィールド値 (19)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (20)
 fieldName string

フィールドの名前
フォーム フィールド値 (20)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (21)
 fieldName string

フィールドの名前
フォーム フィールド値 (21)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (22)
 fieldName string

フィールドの名前
フォーム フィールド値 (22)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (23)
 fieldName string

フィールドの名前
フォーム フィールド値 (23)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (24)
 fieldName string

フィールドの名前
フォーム フィールド値 (24)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (25)
 fieldName string

フィールドの名前
フォーム フィールド値 (25)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (26)
 fieldName string

フィールドの名前
フォーム フィールド値 (26)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (27)
 fieldName string

フィールドの名前
フォーム フィールド値 (27)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (28)
 fieldName string

フィールドの名前
フォーム フィールド値 (28)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (29)
 fieldName string

フィールドの名前
フォーム フィールド値 (29)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (30)
 fieldName string

フィールドの名前
フォーム フィールド値 (30)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (31)
 fieldName string

フィールドの名前
フォーム フィールド値 (31)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (32)
 fieldName string

フィールドの名前
フォーム フィールド値 (32)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (33)
 fieldName string

フィールドの名前
フォーム フィールド値 (33)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (34)
 fieldName string

フィールドの名前
フォーム フィールド値 (34)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (35)
 fieldName string

フィールドの名前
フォーム フィールド値 (35)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (36)
 fieldName string

フィールドの名前
フォーム フィールド値 (36)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (37)
 fieldName string

フィールドの名前
フォーム フィールド値 (37)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (38)
 fieldName string

フィールドの名前
フォーム フィールド値 (38)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (39)
 fieldName string

フィールドの名前
フォーム フィールド値 (39)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (40)
 fieldName string

フィールドの名前
フォーム フィールド値 (40)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (41)
 fieldName string

フィールドの名前
フォーム フィールド値 (41)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (42)
 fieldName string

フィールドの名前
フォーム フィールド値 (42)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (43)
 fieldName string

フィールドの名前
フォーム フィールド値 (43)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (44)
 fieldName string

フィールドの名前
フォーム フィールド値 (44)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (45)
 fieldName string

フィールドの名前
フォーム フィールド値 (45)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (46)
 fieldName string

フィールドの名前
フォーム フィールド値 (46)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (47)
 fieldName string

フィールドの名前
フォーム フィールド値 (47)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (48)
 fieldName string

フィールドの名前
フォーム フィールド値 (48)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (49)
 fieldName string

フィールドの名前
フォーム フィールド値 (49)
 defaultValue string

フィールドの既定値
フォーム フィールド名 (50)
 fieldName string

フィールドの名前
フォーム フィールド値 (50)
 defaultValue string

フィールドの既定値

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponse

ワークフローから契約を作成し、署名を送信する

操作 ID:
CreateAgreementFromWorkflow

この操作により、Adobe Acrobat Sign のワークフローから契約が作成され、署名用に送信されます。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user True string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId True string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります
ワークフロー名/ID
 workflowIdParam True string

一覧からカスタム ワークフローを選択するか、カスタム ワークフロー ID を入力します。
agreementWorkflowSchema
 agreementWorkflowSchema True dynamic

選択したイベントの詳細。

戻り値

新しく作成された契約の ID を含む JSON

Body
AgreementCreationResponseV6

ワークフローの詳細情報を取得する

操作 ID:
GetWorkflowInfo

この操作により、ワークフローに関する詳細な情報がフェッチされます。

パラメーター

名前 キー 必須 型 説明
ワークフロー ID
 workflowId True string

情報が必要なワークフローのワークフロー ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります

戻り値

ワークフローに関する詳細情報を含む JSON

Body
WorkflowDescriptionV6

契約からすべてのドキュメント ID の一覧を取得する

操作 ID:
GetAllDocumentsofAnAgreement_V2

この操作により、契約のすべてのドキュメントとサポート ドキュメントの ID がフェッチされます。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

ドキュメントが必要な契約の契約 ID
サポート ドキュメント - コンテンツ タイプ
 supportingDocumentContentFormat string

契約のサポート ドキュメントのコンテンツ タイプ
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON

Body
AgreementDocumentsV6

契約からすべてのドキュメント ID の一覧を取得する [非推奨]

操作 ID:
GetAllDocumentsofAnAgreement

このアクションは非推奨になりました。 代わりに 、契約からすべてのドキュメント ID の一覧を取得するを 使用してください。

この操作により、契約のすべてのドキュメントとサポート ドキュメントの ID がフェッチされます。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

ドキュメントが必要な契約の契約 ID
サポート ドキュメント - コンテンツ タイプ
 supportingDocumentContentFormat string

契約のサポート ドキュメントのコンテンツ タイプ

戻り値

ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON

Body
AgreementDocuments

契約からドキュメントを取得する

操作 ID:
GetDocument_V2

この操作は、契約の特定のドキュメントのファイル ストリームをフェッチします。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

ドキュメントが必要な契約の契約 ID
ドキュメント ID
 documentId True string

契約の特定のドキュメントのドキュメント ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

ドキュメントのファイル ストリーム

response
DocumentResponse

契約からドキュメントを取得する [非推奨]

操作 ID:
GetDocument

このアクションは非推奨になりました。 代わりに、 契約からドキュメントを取得するを 使用してください。

この操作は、契約の特定のドキュメントのファイル ストリームをフェッチします。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

ドキュメントが必要な契約の契約 ID
ドキュメント ID
 documentId True string

契約の特定のドキュメントのドキュメント ID

戻り値

ドキュメントのファイル ストリーム

response
DocumentResponse

契約のフォーム フィールド データを取得する (古い) [非推奨]

操作 ID:
GetAgreementFormFieldData

契約の対話型フォーム フィールドに入力されたデータを取得します。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

情報が必要な契約の契約 ID

戻り値

response
file

契約の状態を取得する

操作 ID:
GetAgreementInfo_V2

この操作では、状態など、契約のすべての現在の情報がフェッチされます。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

情報が必要な契約の契約 ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

完全な契約の詳細

Body
AgreementInfoV6

契約の状態を取得する [非推奨]

操作 ID:
GetAgreementInfo

このアクションは非推奨になりました。 代わりに、[ 契約の状態を取得する] を 使用してください。

この操作では、状態など、契約のすべての現在の情報がフェッチされます。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

情報が必要な契約の契約 ID

戻り値

契約に関する完全な詳細

Body
AgreementInfo

契約の監査証跡の PDF を取得する

操作 ID:
GetAgreementAuditTrail

この操作により、契約監査証跡の PDF ファイル ストリームがフェッチされます。 ファイル ストリームは、ファイル拡張子で終わるファイル名 .pdf 格納する必要があることに注意してください。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
契約 ID
 agreementId True string

情報が必要な契約の契約 ID

戻り値

契約監査証跡のファイル ストリーム

response
AgreementAuditTrailResponse

契約を取り消す

操作 ID:
CancelAgreement

パス内の agreementId によって識別される契約を取り消します。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

取り消される契約の契約 ID。
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
Agrement State
 state string

契約が成立する必要がある状態。
コメント
 comment string

受信者へのキャンセルの理由を説明する省略可能なコメント。
その他
 notifyOthers boolean

受信者に通知を受け取るかどうか。

契約ビューの URL を取得する

操作 ID:
PostAgreementViews

契約の最新の状態ビュー URL を取得します。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

情報が必要な契約の契約 ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
ビュー名
 name True string

要求された契約ビューの名前
Auto LogIn
 autoLoginUser boolean

true の場合、返される URL は自動的にユーザーをログインさせます。
Chrome フラグなし
 noChrome boolean

true の場合、埋め込みページはヘッダーまたはフッターなしで表示されます
フレームの親
 frameParent string

URL が iframed される可能性があるドメイン URL のコンマ区切りリスト

戻り値

契約ビューの一覧

Body
AgreementViews

検索条件に基づいてすべての契約の一覧を取得する

操作 ID:
SearchAgreements

この操作は、ワークフロー ID などの条件で契約を検索します。

パラメーター

名前 キー 必須 型 説明
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド 'In The Name Of' を選択する必要があります
ワークフロー名/ID
 workflowId string

一覧からカスタム ワークフローを選択するか、カスタム ワークフロー ID を入力します。
作成後
 gt string

許容される最小日時。 例: 2020-12-31T23:59:00Z
以前に作成済み
 lt string

許容される最大日時。 例: 2023-12-31T23:59:00Z
ページ サイズ
 pageSize integer

応答ページ内の項目の数。 既定では 50。最大: 500
開始インデックス
 startIndex integer

返される検索結果の 0 から始まる最初の行 (オフセット)。

戻り値

ユーザー契約配列オブジェクトを含む JSON

Body
userAgreementListV6

署名 URL を取得する

操作 ID:
GetSigningUrls

この操作では、契約の現在の署名者の電子署名ページの URL を取得します。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

契約を作成するアクションによって提供される契約 ID
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

Body
SigningUrlResponse

署名済み契約の PDF を取得する

操作 ID:
GetCombinedDocument_V2

この操作により、結合または署名された契約の PDF ファイル ストリームがフェッチされます。 ファイル ストリームは、ファイル拡張子で終わるファイル名 .pdf 格納する必要があることに注意してください。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

契約を作成するアクションによって提供される契約 ID
サポート ドキュメントを添付しますか?
 attachSupportingDocuments boolean

true の場合は、署名済み契約 PDF にサポート ドキュメントを添付します
監査レポートを添付しますか?
 attachAuditReport boolean

true の場合は、署名済み契約 PDF に監査レポートを添付します
の名前
 x-api-user string

形式の API 呼び出し元の電子メール: 電子メール:adobesignuser@domain.com

戻り値

ドキュメントのファイル ストリーム

response
CombinedDocumentResponse

署名済み契約の PDF を取得する [非推奨]

操作 ID:
GetCombinedDocument

このアクションは非推奨になりました。 代わりに 、署名済み契約の PDF を取得するを 使用してください。

この操作により、結合または署名された契約の PDF ファイル ストリームがフェッチされます。 ファイル ストリームは、ファイル拡張子で終わるファイル名 .pdf 格納する必要があることに注意してください。

パラメーター

名前 キー 必須 型 説明
契約 ID
 agreementId True string

契約を作成するアクションによって提供される契約 ID
サポート ドキュメントを添付しますか?
 attachSupportingDocuments boolean

true の場合は、署名済み契約 PDF にサポート ドキュメントを添付します
監査レポートを添付しますか?
 auditReport boolean

true の場合は、署名済み契約 PDF に監査レポートを添付します

戻り値

ドキュメントのファイル ストリーム

response
CombinedDocumentResponse

トリガー

Web フォーム契約イベントが発生した場合

Web フォームアグリーメント イベントが発生したときに、新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントについて説明します。
イベントが発生した場合

イベントが発生したときに新しいフローをトリガーします。 契約、メガ サイン、Web フォームのすべてのイベントについて説明します。
グループ イベントが発生した場合

グループ イベントが発生したときに新しいフローをトリガーします。 契約、メガ サイン、Web フォームのすべてのイベントについて説明します。
契約が参加者に送信されたとき

契約が参加者に送信されたときに、新しいフローをトリガーします。
契約の状態が変わる場合

契約の状態が変更されたときに新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントについて説明します。
契約ワークフローが正常に完了したとき

契約ワークフローが正常に完了したときに新しいフローをトリガーします
新しい契約が作成されたとき

新しい契約が作成されたときに新しいフローをトリガーします。

Web フォーム契約イベントが発生した場合

操作 ID:
CreateWebhookForWebFormAgreementEvent

Web フォームアグリーメント イベントが発生したときに、新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントについて説明します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
Web フォームのページ サイズ
 pageSize integer

ドロップダウン リストに表示する Web フォームの数を選択する
Web フォーム名/ID
 resourceId True string

リストから Web フォームを選択するか、Web フォーム ID を入力します。
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?
契約ドキュメント情報を含める
 includeDocumentsInfo boolean

契約ドキュメント情報を通知で送信する必要がありますか?
契約署名済みドキュメント情報を含める
 includeSignedDocuments boolean

契約完了の通知で署名済みドキュメントの最終的なコピーを送信する必要がありますか?

戻り値

Body
WebFormWebhookAgreementEventPayload

イベントが発生した場合

操作 ID:
CreateWebhookGeneric

イベントが発生したときに新しいフローをトリガーします。 契約、メガ サイン、Web フォームのすべてのイベントについて説明します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
Scope
 scope True string

トリガーのスコープ
リソースの種類
 resourceType string

"スコープ" が "特定のリソース" の場合にのみ指定します。 フローをトリガーするリソースの種類を選択します。
リソースID
 resourceId string

"スコープ" が "特定のリソース" の場合にのみ指定します。 フローをトリガーする契約またはメガ サインまたは Web フォームまたはグループ ID を入力します。
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?
契約ドキュメント情報を含める
 includeDocumentsInfo boolean

契約ドキュメント情報を通知で送信する必要がありますか?
契約署名済みドキュメント情報を含める
 includeSignedDocuments boolean

契約完了に関する署名済みドキュメントの最終的なコピーを通知で送信する必要がありますか?
MegaSign Info を含める
 includeDetailedInfo boolean

詳細なメガ サイン情報を通知で送信する必要がありますか?
Web フォーム情報を含める
 includeDetailedInfo boolean

詳細な Web フォーム情報を通知で送信する必要がありますか?
Web フォーム参加者情報を含める
 includeParticipantsInfo boolean

Web フォームの参加者情報を通知で送信する必要がありますか?
Web フォーム ドキュメント情報を含める
 includeDocumentsInfo boolean

Web フォームのドキュメント情報を通知で送信する必要がありますか?

戻り値

Body
WebhookPayloadGeneric

グループ イベントが発生した場合

操作 ID:
CreateWebhookForGroupEvent

グループ イベントが発生したときに新しいフローをトリガーします。 契約、メガ サイン、Web フォームのすべてのイベントについて説明します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
グループ名/ID
 resourceId string

グループの ID
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?
契約ドキュメント情報を含める
 includeDocumentsInfo boolean

契約ドキュメント情報を通知で送信する必要がありますか?
契約署名済みドキュメント情報を含める
 includeSignedDocuments boolean

契約完了に関する署名済みドキュメントの最終的なコピーを通知で送信する必要がありますか?
MegaSign Info を含める
 includeDetailedInfo boolean

詳細なメガ サイン情報を通知で送信する必要がありますか?
Web フォーム情報を含める
 includeDetailedInfo boolean

詳細な Web フォーム情報を通知で送信する必要がありますか?
Web フォーム参加者情報を含める
 includeParticipantsInfo boolean

Web フォームの参加者情報を通知で送信する必要がありますか?
Web フォーム ドキュメント情報を含める
 includeDocumentsInfo boolean

Web フォームのドキュメント情報を通知で送信する必要がありますか?

戻り値

Body
GroupWebhookEventPayload

契約が参加者に送信されたとき

操作 ID:
CreateWebhookForAgreementSignatureRequestedEvent

契約が参加者に送信されたときに、新しいフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
Scope
 scope True string

トリガーのスコープ
契約名/ID
 resourceId string

"Scope" が "A specific agreement" の場合にのみ指定します。 一覧から契約を選択するか、契約 ID を入力します。
Subscription
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?
契約ドキュメント情報を含める
 includeDocumentsInfo boolean

契約ドキュメント情報を通知で送信する必要がありますか?

戻り値

Body
WebhookPayload

契約の状態が変わる場合

操作 ID:
CreateWebhookForAgreementStatusUpdated

契約の状態が変更されたときに新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントについて説明します。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
Scope
 scope True string

トリガーのスコープ
契約名/ID
 resourceId string

"Scope" が "A specific agreement" の場合にのみ指定します。 一覧から契約を選択するか、契約 ID を入力します。
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?
契約ドキュメント情報を含める
 includeDocumentsInfo boolean

契約ドキュメント情報を通知で送信する必要がありますか?
契約署名済みドキュメント情報を含める
 includeSignedDocuments boolean

契約完了の通知で署名済みドキュメントの最終的なコピーを送信する必要がありますか?

戻り値

Body
WebhookPayloadWithSignedDocumentForStatusChange

契約ワークフローが正常に完了したとき

操作 ID:
CreateWebhookForAgreementSignedEvent

契約ワークフローが正常に完了したときに新しいフローをトリガーします

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
Scope
 scope True string

トリガーのスコープ
契約名/ID
 resourceId string

"Scope" が "A specific agreement" の場合にのみ指定します。 一覧から契約を選択するか、契約 ID を入力します。
Subscription
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?
契約ドキュメント情報を含める
 includeDocumentsInfo boolean

契約ドキュメント情報を通知で送信する必要がありますか?
契約署名済みドキュメント情報を含める
 includeSignedDocuments boolean

契約完了に関する署名済みドキュメントの最終的なコピーを通知で送信する必要がありますか?

戻り値

Body
WebhookPayloadWithSignedDocument

新しい契約が作成されたとき

操作 ID:
CreateWebhookForAgreementCreatedEvent

新しい契約が作成されたときに新しいフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
名前
 name True string

トリガーの名前
Scope
 scope True string

トリガーのスコープ
Subscription
 webhookSubscriptionEvents True array of string

フローをトリガーする必要があるイベント
契約情報を含める
 includeDetailedInfo boolean

詳細な契約情報を通知で送信する必要がありますか?
契約参加者情報を含めますか?
 includeParticipantsInfo boolean

契約参加者の情報を通知で送信する必要がありますか?

戻り値

Body
WebhookPayloadWithoutNextParticipantSet

定義

AgreementCreationResponse

新しく作成された契約の ID を含む JSON

名前 パス 型 説明
契約 ID
 agreementId string

状態の照会と署名済みドキュメントのダウンロードに使用できる契約の一意の ID

AgreementCreationResponseV6

新しく作成された契約の ID を含む JSON

名前 パス 型 説明
契約 ID
 id string

状態の照会と署名済みドキュメントのダウンロードに使用できる契約の一意の ID

AgreementDocuments

ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON

名前 パス 型 説明
ドキュメント​
 documents array of Document

ドキュメントを表すオブジェクトの一覧
サポート ドキュメント
 supportingDocuments array of SupportingDocument

サポート ドキュメントの一覧。 これは、契約に関連するドキュメントがある場合にのみ返されます

AgreementDocumentsV6

ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON

名前 パス 型 説明
ドキュメント​
 documents array of DocumentV6

ドキュメントを表すオブジェクトの一覧
サポート ドキュメント
 supportingDocuments array of SupportingDocumentV6

サポート ドキュメントの一覧。 これは、契約に関連するドキュメントがある場合にのみ返されます

AgreementInfo

契約に関する完全な詳細

名前 パス 型 説明
契約 ID
 agreementId string

契約を一意に識別するために使用できる一意の ID
イベント
 events array of DocumentHistoryEvent

このドキュメントの監査証跡のイベントの順序付きリスト
有効期限
 expiration date

契約に署名できなくなった日付
最新バージョン ID
 latestVersionId string

契約の現在のバージョンを一意に識別する一意の ID
メッセージ
 message string

送信者が提供した契約に関連付けられているメッセージ
契約名
 name string

差出人によって指定された契約の名前
次の参加者セット
 nextParticipantSetInfos array of NextParticipantSetInfo

本契約の次に行動する必要があるユーザーに関する情報
参加者セット
 participantSetInfos array of ParticipantSetInfo

このドキュメントのすべての参加者セットに関する情報
署名の種類
 signatureType string

要求された署名の種類 (E 署名または書き込み) を指定します
ドキュメント保護
 securityOptions string

表示および署名にパスワードが必要かどうかを指定するドキュメントに関するセキュリティ情報
ステータス
 status string

契約の現在の状態

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

要求された署名の種類 (E 署名または書き込み) を指定します
セキュリティ オプション
 securityOptions string

表示および署名にパスワードが必要かどうかを指定するドキュメントに関するセキュリティ情報
ステータス
 status string

契約の現在の状態
送信者の電子メール
 senderEmail string

送信者の電子メール
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID。
CC
 ccs array of CcInfo

契約トランザクションでコピーされる 1 つ以上の CC の一覧。
グループ識別子
 groupId string

契約が属するグループの一意識別子。

CombinedDocumentResponse

ドキュメントのファイル ストリーム

ドキュメントのファイル ストリーム

ファイル コンテンツ
binary

AgreementAuditTrailResponse

契約監査証跡のファイル ストリーム

契約監査証跡のファイル ストリーム

契約監査証跡のコンテンツ
binary

DisplayUserInfo

名前 パス 型 説明
[会社]
 company string

ユーザーの会社の名前を表示します (使用可能な場合)。
Email
 email string

ユーザーの電子メールを表示します
氏名
 fullName string

使用可能な場合は、ユーザーの完全な名前を表示します。

DisplayUserSetInfo

名前 パス 型 説明
ユーザー セット情報の表示
 displayUserSetMemberInfos array of DisplayUserInfo

ユーザー セットに関する情報を表示します
ユーザー セット名の表示
 displayUserSetName string

ドキュメント

ドキュメントに関する情報

名前 パス 型 説明
ドキュメント ID
 documentId string

ドキュメントの一意の ID
Mime の種類
 mimeType string

ドキュメントの Mime の種類
名前
 name string

ドキュメントの名前
ページ数
 numPages integer

ドキュメント内のページ数

DocumentV6

ドキュメントに関する情報

名前 パス 型 説明
ドキュメント ID
 id string

ドキュメントの一意の ID
Mime の種類
 mimeType string

ドキュメントの Mime の種類
名前
 name string

ドキュメントの名前
ページ数
 numPages integer

ドキュメント内のページ数

DocumentHistoryEvent

名前 パス 型 説明
イベント イニシエーター
 actingUserEmail string

イベントを開始したユーザーの電子メール アドレス
イベントの日付
 date date

監査イベントの日付
イベントの説明
 description string

監査イベントの説明
参加者の電子メール
 participantEmail string

イベントを開始したユーザーの電子メール アドレス
イベントの種類
 type string

契約イベントの種類

DocumentLibraryItem

名前 パス 型 説明
ライブラリ テンプレート ID
 libraryDocumentId string

署名するドキュメントを送信するときに使用されるライブラリ ドキュメントの一意の ID
ライブラリ テンプレートの種類
 libraryTemplateTypes array of string

1 つ以上のライブラリ テンプレートの種類の一覧
変更日
 modifiedDate date

ライブラリ テンプレートが最後に変更された日
ライブラリ テンプレート名
 name string

ライブラリ テンプレートの名前
テンプレート共有モード
 scope string

ライブラリ テンプレートの可視性のスコープ

DocumentLibraryItems

ライブラリ テンプレート配列オブジェクトを含む JSON

名前 パス 型 説明
ライブラリ テンプレートの一覧
 libraryDocumentList array of DocumentLibraryItem

ライブラリ テンプレート項目の一覧

DocumentResponse

ドキュメントのファイル ストリーム

ドキュメントのファイル ストリーム

ファイル コンテンツ
binary

LibraryDocumentCreationResponse

ライブラリ テンプレートを記述する JSON オブジェクト

名前 パス 型 説明
ライブラリ テンプレート ID
 libraryDocumentId string

ライブラリ テンプレートを参照するために使用できる一意の ID

NextParticipantInfo

名前 パス 型 説明
Email
 email string

次の参加者のメール アドレス
名前
 name string

次の参加者の名前 (使用可能な場合)
Waiting Since
 waitingSince date

ドキュメントが参加者のアクションの実行を待機している日付

NextParticipantSetInfo

名前 パス 型 説明
次の参加者セットメンバー情報
 nextParticipantSetMemberInfos array of NextParticipantInfo

次の参加者セットのメンバーに関する情報

ParticipantInfo

名前 パス 型 説明
[会社]
 company string

参加者の会社 (使用可能な場合)
Email
 email string

参加者のメール アドレス
名前
 name string

参加者の名前 (使用可能な場合)
参加者 ID
 participantId string

参加者の一意の ID
セキュリティ オプション
 securityOptions array of string

参加者に適用されるセキュリティ オプション
Title
 title string

参加者のタイトル (使用可能な場合)

ParticipantSetInfo

名前 パス 型 説明
参加者セット ID
 participantSetId string

参加者セットの一意の ID
参加者セットメンバー情報
 participantSetMemberInfos array of ParticipantInfo

受信者セットのメンバーに関する情報
プライベート メッセージ
 privateMessage string

セット内の参加者のプライベート メッセージ
Role
 roles array of string

参加者セットの現在のロール。 参加者セットには、1 つ以上のロールを含めることができます
securityOptions
 securityOptions array of string

参加者に適用されるセキュリティ オプション
署名順序
 signingOrder integer

この受信者が署名する順序を示す 1 から始まるインデックス
参加者セットの状態
 status string

ドキュメントに関する参加者セットの状態

ParticipantSetInfoV6

名前 パス 型 説明
参加者セットメンバー情報
 memberInfos array of MemberInfosV6

受信者セットのメンバーに関する情報
注文
 order integer

署名グループが署名する必要がある位置を示すインデックス。
Role
 role string

参加者セットの現在のロール (署名者、承認者など)。
参加者セット名
 name string

参加者セットの名前
参加者セットプライベートメッサージュ
 privateMessage string

セット内の参加者のプライベート メッセージ
参加者セットの表示ページ
 visiblePages array of string

参加者セットに表示されるページ

MemberInfosV6

名前 パス 型 説明
Email
 email string

参加者の電子メール
Authentication
 securityOption.authenticationMethod string

既定の認証: 電子メール (なし)
パスワード
 securityOption.password string

参加者に必要なパスワード
国番号
 securityOption.phoneInfo.countryCode string

ドキュメントの表示と署名に必要な受信者の電話の国コード
電話番号。
 securityOption.phoneInfo.phone string

契約の表示と署名に必要な受信者の電話番号
プロバイダー ID
 securityOption.digAuthInfo.providerId string

デジタル ID ゲートウェイ プロバイダー ID。

SigningUrl

名前 パス 型 説明
署名 URL の電子メール
 email string

この署名 URL に関連付けられている署名者の電子メール アドレス
URL に署名する
 esignUrl string

この署名 URL に関連付けられている署名者の URL アドレス

SigningUrlResponse

名前 パス 型 説明
署名者セットの URL の配列
 signingUrlSetInfos array of SigningUrlSetInfo

この契約に関係する署名者セットの URL の配列

SigningUrlSetInfo

名前 パス 型 説明
- 署名 URL 配列
 signingUrls array of SigningUrl

現在の署名者セットの URL の配列
- URL セット名に署名する
 signingUrlSetName string

現在の署名者セットの名前

SupportingDocument

サポート ドキュメントに関する情報

名前 パス 型 説明
ドキュメント名のサポート
 displayLabel string

サポート ドキュメントの表示名
ドキュメント フィールド名のサポート
 fieldName string

サポート ドキュメント フィールドの名前
ドキュメント MIME の種類のサポート
 mimeType string

サポート ドキュメントの Mime の種類
ドキュメント ページのサポート
 numPages integer

サポート ドキュメント内のページ数
ドキュメント ID のサポート
 supportingDocumentId string

サポート ドキュメントを表す一意の ID

SupportingDocumentV6

サポート ドキュメントに関する情報

名前 パス 型 説明
ドキュメント名のサポート
 displayLabel string

サポート ドキュメントの表示名
ドキュメント フィールド名のサポート
 fieldName string

サポート ドキュメント フィールドの名前
ドキュメント MIME の種類のサポート
 mimeType string

サポート ドキュメントの Mime の種類
ドキュメント ページのサポート
 numPages integer

サポート ドキュメント内のページ数
ドキュメント ID のサポート
 id string

サポート ドキュメントを表す一意の ID

TransientDocumentResponse

アップロードされたドキュメントの ID を含む JSON

名前 パス 型 説明
ドキュメント ID
 transientDocumentId string

アップロードされたドキュメントのドキュメント ID

UserAgreement

名前 パス 型 説明
契約 ID
 agreementId string

契約を一意に識別するために使用できる一意の ID
ユーザー セット情報の表示
 displayUserSetInfos array of DisplayUserSetInfo

契約に最も関連する現在のユーザー セット。 通常、契約が現在のユーザーからの場合は次の署名者、別のユーザーから受信した場合は送信者です
表示日
 displayDate date

契約の表示日
Esign
 esign boolean

これが電子署名ドキュメントの場合は True
最新バージョン ID
 latestVersionId string

契約の現在のバージョンを一意に識別するバージョン ID
名前
 name string

契約の名前
ステータス
 status string

契約の現在の状態

UserAgreements

ユーザー契約配列オブジェクトを含む JSON

名前 パス 型 説明
契約一覧
 userAgreementList array of UserAgreement

契約項目の配列

UserAgreementV6

名前 パス 型 説明
ユーザー セット情報の表示
 displayParticipantSetInfos array of DisplayUserSetInfo

契約に最も関連する現在のユーザー セット。 通常、契約が現在のユーザーからの場合は次の署名者、別のユーザーから受信した場合は送信者です
表示日
 displayDate string

契約の表示日
Esign
 esign boolean

これが電子署名ドキュメントの場合は True
隠れた
 hidden boolean

ユーザーの契約が非表示の場合は True
グループ識別子
 groupId string

グループの一意識別子
最新バージョン ID
 latestVersionId string

契約の現在のバージョンを一意に識別するバージョン ID
名前
 name string

契約の名前
親 ID
 parentId string

megaSign 子の親 ID 、または Web フォーム アグリーメント インスタンスの元の ID
契約 ID
 id string

契約の一意識別子
ステータス
 status string

契約の現在の状態
タイプ
 type string

契約の種類

userAgreementListV6

ユーザー契約配列オブジェクトを含む JSON

名前 パス 型 説明
page
 page page

応答内を移動するための改ページ情報
契約一覧
 userAgreementList array of UserAgreementV6

契約項目の配列

page

応答内を移動するための改ページ情報

名前 パス 型 説明
nextCursor
 nextCursor string

次のページに移動するために使用します。 返されない場合は、それ以上のページはありません。

WebhookPayload

名前 パス 型 説明
Event
 event string

リソースで発生したイベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
イベント リソースの種類
 eventResourceType string

イベントが発生したリソース。
契約の親の種類
 eventResourceParentType string

契約の作成元のリソースに関する情報。 使用可能な値: Web フォームまたはメガ サイン
契約の親 ID
 eventResourceParentId string

この契約の作成元のリソースの一意の ID
イベント参加者ロール
 participantRole string

イベントの参加者のロール。
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID。
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfo

契約の完全な情報

ApplicableUsers

この通知が適用されるユーザーに関する情報

名前 パス 型 説明
通知の適用可能なユーザー ID
 id string

この通知が適用されるユーザーの一意の ID
通知の該当するユーザーの電子メール
 email string

この通知が適用されるユーザーの電子メール
通知の適用可能なユーザー ロール
 role string

この通知が生成されるワークフロー内のユーザーのロール
ペイロードが適用可能なユーザー
 payloadApplicable boolean

この通知で提供されたデータがこのユーザーに適用されるかどうか

WebhookPayloadWithoutNextParticipantSet

名前 パス 型 説明
Event
 event string

リソースで発生したイベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
イベント リソースの種類
 eventResourceType string

イベントが発生したリソース。
契約の親の種類
 eventResourceParentType string

契約の作成元のリソースに関する情報。 使用可能な値: Web フォームまたはメガ サイン
契約の親 ID
 eventResourceParentId string

この契約の作成元のリソースの一意の ID
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfoWithoutNextParticipantSet

契約の完全な情報

WebhookPayloadWithSignedDocumentForStatusChange

名前 パス 型 説明
Event
 event string

リソースで発生したイベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
Sub イベント
 subEvent string

リソースで発生したサブ イベント。
契約の親の種類
 eventResourceParentType string

契約の作成元のリソースに関する情報。 使用可能な値: Web フォームまたはメガ サイン
契約の親 ID
 eventResourceParentId string

この契約の作成元のリソースの一意の ID
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
アクションの種類
 actionType string

イベントが発生したアクション。
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
イベント リソースの種類
 eventResourceType string

イベントが発生したリソース。
イベント参加者ロール
 participantRole string

イベントの参加者のロール。
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfoWithSignedDocument

契約の完全な情報

WebhookPayloadWithSignedDocument

名前 パス 型 説明
Event
 event string

リソースで発生したイベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
契約の親の種類
 eventResourceParentType string

契約の作成元のリソースに関する情報。 使用可能な値: Web フォームまたはメガ サイン
契約の親 ID
 eventResourceParentId string

この契約の作成元のリソースの一意の ID
イベント リソースの種類
 eventResourceType string

イベントが発生したリソース。
イベント参加者ロール
 participantRole string

イベントの参加者のロール。
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfoWithSignedDocument

契約の完全な情報

WebhookPayloadGeneric

名前 パス 型 説明
Event
 event string

リソースで発生したイベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
Sub イベント
 subEvent string

リソースで発生したサブ イベント。
契約の親の種類
 eventResourceParentType string

契約の作成元のリソースに関する情報。 使用可能な値: Web フォームまたはメガ サイン
契約の親 ID
 eventResourceParentId string

この契約の作成元のリソースの一意の ID
イベント リソースの種類
 eventResourceType string

イベントが発生したリソース。
イベント参加者ロール
 participantRole string

イベントの参加者のロール。
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
アクションの種類
 actionType string

イベントが発生したアクション。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の完全な情報
メガ サイン
 megaSign WebhookMegaSignInfo

メガ サインの完全な情報
Web フォーム
 widget WebhookWidgetInfo

Web フォームの完全な情報

WebFormWebhookAgreementEventPayload

名前 パス 型 説明
Event
 event string

Web フォームで発生した契約イベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
Sub イベント
 subEvent string

Web フォームで発生したサブ イベント。
契約の親の種類 - Web フォーム
 eventResourceParentType string

契約が Web フォームから作成されることを示す値。
Web フォーム ID
 eventResourceParentId string

この契約の作成元となる Web フォームの一意の ID
イベント リソースの種類 - 契約
 eventResourceType string

イベントが発生したリソース。
イベント参加者ロール
 participantRole string

イベントの参加者のロール。
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
アクションの種類
 actionType string

イベントが発生したアクション。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の完全な情報

GroupWebhookEventPayload

名前 パス 型 説明
Event
 event string

グループに対して発生したイベント。
イベントの日付
 eventDate date

イベントの日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
Sub イベント
 subEvent string

グループに対して発生したサブ イベント。
契約の親の種類 - Web フォーム
 eventResourceParentType string

契約の作成元グループに関する情報。
Web フォーム ID
 eventResourceParentId string

この契約の作成元グループの一意の ID
イベント リソースの種類 - 契約
 eventResourceType string

イベントが発生したグループ。
イベント参加者ロール
 participantRole string

イベントの参加者のロール。
イベント参加者 ID
 participantUserId string

イベントの参加者の ID。
イベント参加者の電子メール
 participantUserEmail string

イベントの参加者の電子メール。
イベント動作ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID。
Event Acting User Email
 actingUserEmail string

イベントを作成したユーザーの電子メール。
イベント開始ユーザー ID
 initiatingUserId string

代理ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザー電子メール
 initiatingUserEmail string

代理ユーザーに代わってイベントを開始したユーザーの電子メール。
アクションの種類
 actionType string

イベントが発生したアクション。
イベント処理ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
該当するユーザーに通知する
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用されるユーザーの一覧
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の完全な情報
メガ サイン
 megaSign WebhookMegaSignInfo

メガ サインの完全な情報
Web フォーム
 widget WebhookWidgetInfo

Web フォームの完全な情報

WebhookAgreementInfo

契約の完全な情報

名前 パス 型 説明
ID
 id string

契約の一意の ID
名前
 name string

契約の名前
署名の種類
 signatureType string

要求された署名の種類 (E 署名または書き込み) を指定します
ステータス
 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

契約の送信者の電子メール
コンテナー化は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントのコンテナー化用に設定されたアカウントと、契約ごとに有効にするオプションの場合、ドキュメントをコンテナー化するかどうかを決定します。
ドキュメントの表示
 documentVisibilityEnabled boolean

ドキュメントの表示が有効になっているか
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID。
Post Sign Redirect 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

要求された署名の種類 (E 署名または書き込み) を指定します
ステータス
 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

契約の送信者の電子メール
コンテナー化は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントのコンテナー化用に設定されたアカウントと、契約ごとに有効にするオプションの場合、ドキュメントをコンテナー化するかどうかを決定します。
Post Sign Redirect Url
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信されるパブリックにアクセス可能な URL
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID。
参加者セット
 participantSetsInfo.participantSets array of WebhookParticipantSets

参加者が情報を設定する

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の完全な情報

名前 パス 型 説明
ID
 id string

契約の一意の ID
名前
 name string

契約の名前
署名の種類
 signatureType string

要求された署名の種類 (E 署名または書き込み) を指定します
ステータス
 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

参加者にリマインダーを送信する頻度を設定する省略可能なパラメーター。 指定しない場合は、アカウントに設定された既定の頻度が使用されます
Post Sign Redirect Url
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信されるパブリックにアクセス可能な URL
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID。
送信者の電子メール
 senderEmail string

契約の送信者の電子メール
ドキュメントの表示
 documentVisibilityEnabled boolean

ドキュメントの表示が有効になっているか
コンテナー化は有効ですか?
 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

要求された署名の種類 (E 署名または書き込み) を指定します
ステータス
 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

契約の送信者の電子メール
コンテナー化は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントのコンテナー化用に設定されたアカウントと、契約ごとに有効にするオプションの場合、ドキュメントをコンテナー化するかどうかを決定します。
Post Sign Redirect 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

このメガサインにコピーする 1 つ以上のメール アドレスの一覧。
外部 ID
 externalId.id string

システムからの任意の値。送信時に指定し、後で返されるか、クエリを実行できます。
最初のアラームの遅延
 firstReminderDelay integer

最初のアラームを送信するまでの時間単位の遅延を指定する整数。
ロケール
 locale string

この契約に関連付けられているロケール
メッセージ
 message string

送信される内容や署名が必要な理由を説明する、参加者への省略可能なメッセージ
Post Sign Redirect Url
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信されるパブリックにアクセス可能な URL
送信者の電子メール
 senderEmail string

megasign 作成者の電子メール
署名の種類
 signatureType string

要求された署名の種類 (E 署名または書き込み) を指定します
コンテナー化は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントのコンテナー化用に設定されたアカウントと、契約ごとに有効にするオプションの場合、ドキュメントをコンテナー化するかどうかを決定します。
子契約ファイル情報
 childAgreementsInfo.fileInfo MegaSignChildAgreementsFileInfo

megaSign の子契約ごとの情報を含むファイル情報。

WebhookWidgetInfo

Web フォームの完全な情報

名前 パス 型 説明
ID
 id string

Web フォームの一意の ID
名前
 name string

Web フォームの名前
ステータス
 status string

Web フォームの状態
認証エラー情報
 authFailureInfo AuthFailureWidgetRedirectionInfo

認証に失敗した後に Web フォーム署名者が取得するエラー ページの URL と関連プロパティ
CC
 ccs array of WidgetCcInfo

この Web フォームにコピーする 1 つ以上のメール アドレスの一覧。
[作成日付]
 createdDate date

Web フォームが作成された日付
入力候補情報
 completionInfo WidgetCompletionRedirectionInfo

Web フォームの署名者が Web フォームで目的のアクションを実行した後に実行される成功ページの URL と関連付けられたプロパティ
作成者の電子メール
 creatorEmail string

Web フォームの作成者の電子メール
コンテナー化は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントのコンテナー化用に設定されたアカウントと、契約ごとに有効にするオプションの場合、ドキュメントをコンテナー化するかどうかを決定します。
その他の参加者セット情報
 participantSetsInfo.additionalParticipantSets array of WidgetParticipantSetInfo

Web フォームの署名者を除く、Web フォーム内のすべての参加者の一覧
最初の参加者セットロール
 participantSetsInfo.widgetParticipantSet.role string

セット内のすべての参加者 (署名者、承認者など) によって想定されるロール
最初の参加者セットの順序
 participantSetsInfo.widgetParticipantSet.order integer

順次署名グループを示すインデックス (ハイブリッド ルーティング用に指定)
ドキュメント​
 documentsInfo.documents array of WidgetWebhookDocument

ドキュメントを表すオブジェクトの一覧

AuthFailureWidgetRedirectionInfo

認証に失敗した後に Web フォーム署名者が取得するエラー ページの URL と関連プロパティ

名前 パス 型 説明
認証エラーのリダイレクト遅延
 delay integer

ユーザーが結果ページに移動するまでの遅延 (秒単位)
Auth Failure Redirect Deframe
 deframe boolean

デフレームが false の場合、結果ページは Web フォーム フレーム内に表示されます
認証エラーのリダイレクト URL
 url string

Web フォームを正常に完了した後にユーザーが送信されるパブリックにアクセス可能な URL

WidgetCompletionRedirectionInfo

Web フォームの署名者が Web フォームで目的のアクションを実行した後に実行される成功ページの URL と関連付けられたプロパティ

名前 パス 型 説明
完了リダイレクト遅延
 delay integer

ユーザーが結果ページに移動するまでの遅延 (秒単位)
完了リダイレクトデフレーム
 deframe boolean

デフレームが false の場合、結果ページは Web フォーム フレーム内に表示されます
完了リダイレクト URL
 url string

Web フォームを正常に完了した後にユーザーが送信されるパブリックにアクセス可能な URL

WebhookParticipantSets

名前 パス 型 説明
メンバー情報
 memberInfos array of MemberInfos

参加者メンバーに関する情報
注文
 order integer

署名グループが署名する必要がある位置を示すインデックス。
Role
 role string

セット内のすべての参加者 (署名者、承認者など) によって想定されるロール
ステータス
 status string

ユーザーの観点からの契約の現在の状態
ID
 id string

参加者セットの ID
名前
 name string

参加者セットの名前
プライベート メッセージ
 privateMessage string

セット内の参加者のプライベート メッセージ

MegaSignChildAgreementsFileInfo

megaSign の子契約ごとの情報を含むファイル情報。

名前 パス 型 説明
子契約ファイル ID
 childAgreementsInfoFileId string

megaSign の既存の childAgreementsInfo に関する情報を含むファイルの ID。

WidgetWebhookDocument

Web フォームのドキュメントに関する情報

名前 パス 型 説明
ID
 id string

ドキュメントの一意の ID
名前
 name string

ドキュメントの名前

WebhookDocument

契約のドキュメントに関する情報

名前 パス 型 説明
ID
 id string

ドキュメントの一意の ID
名前
 name string

ドキュメントの名前

WebhookSupportingDocument

サポート ドキュメントに関する情報

名前 パス 型 説明
名前
 displayLabel string

サポート ドキュメントの表示名
フィールド名
 fieldName string

サポート ドキュメント フィールドの名前
ID
 id string

サポート ドキュメントを表す一意の ID

WidgetCcInfo

Web フォームの CC に関する情報

名前 パス 型 説明
Email
 email string

Web フォームの CC 参加者の電子メール

MegaSignCcInfo

メガ サインの CC に関する情報

名前 パス 型 説明
Email
 email string

メガサインの CC 参加者の電子メール

CcInfo

契約の CC に関する情報

名前 パス 型 説明
Email
 email string

契約の CC の電子メール
ラベル
 label string

ワークフローの説明で返される CC リストのラベル
表示ページ
 visiblePages array of string

CC に表示されるページ

WidgetParticipantSetInfo

名前 パス 型 説明
Role
 role string

セット内のすべての参加者 (署名者、承認者など) によって想定されるロール
ID
 id string

参加者セットの一意識別子
メンバー情報
 memberInfos array of MemberInfos

参加者メンバーに関する情報
注文
 order integer

順次署名グループを示すインデックス (ハイブリッド ルーティング用に指定)

MemberInfos

名前 パス 型 説明
ID
 id string

参加者の一意の ID
Email
 email 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

ライブラリ ドキュメント作成者の電子メール アドレス。
グループ識別子
 groupId string

ライブラリ テンプレートが属するグループの一意識別子。
ステータス
 status string

ライブラリ ドキュメントの状態

LibraryDocuments

ライブラリ テンプレート配列オブジェクトを含む JSON

名前 パス 型 説明
page
 page page

応答内を移動するための改ページ情報
ライブラリ テンプレートの一覧
 libraryDocumentList array of LibraryDocument

ライブラリ テンプレート項目の一覧

UserWidgetV6

名前 パス 型 説明
Web フォーム ID
 id string

Web フォームの一意識別子
変更日
 modifiedDate string

Web フォームが最後に変更された日付
隠れた
 hidden boolean

ユーザーの契約が非表示の場合は True
グループ識別子
 groupId string

グループの一意識別子
名前
 name string

Web フォームの名前
ステータス
 status string

Web フォームの状態
ウェブアドレス
 url string

Web フォームのホスト URL
Javascript
 javascript string

Web フォームの埋め込み JavaScript コード

userWidgetListV6

ユーザー Web フォーム配列オブジェクトを含む JSON

名前 パス 型 説明
page
 page page

応答内を移動するための改ページ情報
Web フォーム リスト
 userWidgetList array of UserWidgetV6

Web フォームアイテムの配列

UserWorkflowV6

名前 パス 型 説明
ワークフロー ID
 id string

ワークフローの一意識別子
Description
 description string

このワークフローの作成時に指定された説明
作成日
 created string

ワークフローが作成された日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります
変更日
 modified string

ワークフローが変更された日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります
名前
 name string

ワークフローの名前
表示される名前
 displayName string

ワークフローの表示名
ステータス
 status string

ワークフローの状態
Scope
 scope string

ワークフロー スコープ
発信元 ID
 originatorId string

ワークフローの最初の発信元
スコープ ID
 scopeId string

スコープの識別子。 現時点では、スコープ GROUP にのみ適用され、値は groupId になります。

userWorkflowListV6

ユーザー ワークフロー配列オブジェクトを含む JSON

名前 パス 型 説明
ワークフロー リスト
 userWorkflowList array of UserWorkflowV6

ワークフロー 項目の配列

WorkflowDefaultParamsV6

ワークフローの既定の params オブジェクトを含む JSON

名前 パス 型 説明
デフォルト値
 defaultValue string

このフィールドの入力が指定されておらず、このフィールドが必要な場合のフィールドの既定値
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
必須
 required boolean

このフィールドが必須か省略可能か
目に見える
 visible boolean

現在のフィールドが表示されているかどうか。 このフィールドの表示属性が false の場合、このフィールドは、このワークフローを使用してユーザーに契約作成 UI に表示されないようにする必要があります

CCsListInfoDescriptionV6

ワークフローに関する詳細情報を含む JSON

名前 パス 型 説明
既定値
 defaultValues array of string

このリスト要素に入力が指定されていない場合に使用される既定の電子メールの配列
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
ラベル
 label string

現在の CC リストに使用できるワークフロー ユーザーの表示テキスト
最大 CC エントリ数
 maxListCount integer

現在の CC リストで許可されているエントリの最大数
最小 CC エントリ数
 minListCount integer

現在の CC リストで許可されているエントリの最小数
CC リスト名
 name string

現在の CC リストの名前
必須
 required boolean

このフィールドが必須か省略可能か
目に見える
 visible boolean

現在のフィールドが表示されているかどうか。 このフィールドの表示属性が false の場合、このフィールドは、このワークフローを使用して契約作成ページに表示されません。

ExpirationFieldInfoDescriptionV6

有効期限に関する情報を含む JSON

名前 パス 型 説明
デフォルト値
 defaultValue string

このフィールドの入力が指定されておらず、このフィールドが必要な場合のフィールドの既定値
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
契約の有効期限の最大日数
 maxDays integer

契約の有効期限の最大日数
必須
 required boolean

このフィールドが必須か省略可能か
目に見える
 visible boolean

現在のフィールドが表示されているかどうか。 このフィールドの表示属性が false の場合、このフィールドは、このワークフローを使用して契約作成ページに表示されません。

FileInfosDescriptionV6

ファイルに関する情報を含む JSON

名前 パス 型 説明
ラベル
 label string

外部ユーザー用にこのフィールドのラベルを表示する
名前
 name string

fileInfo 要素の名前
必須
 required boolean

このフィールドが必須か省略可能か
ワークフロー ライブラリ ドキュメント
 workflowLibraryDocumentSelectorList array of WorkflowLibraryDocumentV6

この fileInfo オブジェクトで 1 つのワークフロー ライブラリ ドキュメントを選択できるワークフロー ライブラリ ドキュメントの一覧

WorkflowLibraryDocumentV6

ワークフロー ライブラリ ドキュメントに関する情報を含む JSON

名前 パス 型 説明
ラベル
 label string

ワークフロー ユーザー向けのこのフォームの表示テキスト
変更日
 modifiedDate string

ライブラリ ドキュメントが最後に変更された日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ になります。 たとえば、2016-02-25T18:46:19Z は UTC 時刻を表します
共有モード
 sharingMode string

このライブラリ ドキュメントにアクセスできるユーザーを指定します。 GLOBAL 共有は制限付き操作です
テンプレートの種類
 templateTypes array of

1 つ以上のライブラリ テンプレートの種類の一覧
ワークフロー ライブラリのドキュメント ID
 workflowLibDoc string

カスタム ワークフロー 契約作成要求で入力ファイルとして提供できるワークフロー ライブラリ ドキュメントの ID

LocaleFieldInfoDescriptionV6

ワークフロー ロケールに関する詳細情報を含む JSON

名前 パス 型 説明
使用可能なロケール
 availableLocales array of string

このワークフローで選択できるロケール
デフォルト値
 defaultValue string

このフィールドの入力が指定されておらず、このフィールドが必要な場合のフィールドの既定値
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
必須
 required boolean

このフィールドが必須か省略可能か
目に見える
 visible boolean

現在のフィールドが表示されているかどうか。 このフィールドの表示属性が false の場合、このフィールドは、このワークフローを使用してユーザーに契約作成 UI に表示されないようにする必要があります

MergeFieldInfoDescriptionV6

マージ フィールドに関する詳細情報を含む JSON

名前 パス 型 説明
デフォルト値
 defaultValue string

このフィールドの入力が指定されておらず、このフィールドが必要な場合のフィールドの既定値
表示される名前
 displayName string

このユーザー設定フィールドに表示できる表示テキスト
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
ユーザー設定フィールド名
 fieldName string

このワークフローのユーザー設定フィールドの名前
必須
 required boolean

このフィールドが必須か省略可能か
目に見える
 visible boolean

契約の作成ページに現在のフィールドを表示するかどうかを指定します。 このフィールドの表示属性が false の場合、このフィールドは、このワークフローを使用して契約作成ページに表示されません

PasswordFieldInfoDescriptionV6

パスワードに関する詳細情報を含む JSON

名前 パス 型 説明
パスワード
 defaultValue string

パスワード情報フィールドの既定値
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
ラベル
 label string

パスワード フィールドのラベル
名前
 name string

パスワード フィールドの名前
必須
 required boolean

このフィールドが必須か省略可能か
目に見える
 visible boolean

契約の作成ページにパスワード情報フィールドが表示されるかどうか

RecipientsListInfoDescriptionV6

受信者リストに関する詳細情報を含む JSON

名前 パス 型 説明
送信者を許可する
 allowSender boolean

送信者が受信者として許可されるかどうか
送信者を許可する
 allowfax boolean

FAX が許可されているかどうか
認証方法
 authenticationMethod string

ドキュメントを表示および署名するためのアクセス権を持つ現在の受信者リストの認証方法。
既定の電子メール/FAX 値
 defaultValue string

既定の電子メールまたは FAX 番号
編集可能
 editable boolean

現在のフィールドを編集できるかどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約作成要求で指定しないでください。このフィールドの既定値は契約の作成時に使用されます
ラベル
 label string

現在の受信者リストに使用できるワークフロー ユーザーの表示テキスト
最大受信者数
 maxListCount integer

現在の受信者リストで許可されるエントリの最大数
最小受信者数
 minListCount integer

現在の受信者リストで許可されているエントリの最小数
受信者情報リストの名前
 name string

現在の受信者情報リストの名前
参加者ロール
 role string

参加者の現在の役割
目に見える
 visible boolean

現在のフィールドが表示されるかどうか。 このフィールドの表示属性が false の場合、このワークフローを使用してユーザーに契約作成 UI にこのフィールドを表示しないでください

WorkflowDescriptionV6

ワークフローに関する詳細情報を含む JSON

名前 パス 型 説明
agreementNameInfo
 agreementNameInfo WorkflowDefaultParamsV6

ワークフローの既定の params オブジェクトを含む JSON
authoringInfo
 authoringInfo WorkflowDefaultParamsV6

ワークフローの既定の params オブジェクトを含む JSON
CC リスト情報
 ccsListInfo array of CCsListInfoDescriptionV6

契約作成要求の CC リスト入力フィールドに関する情報
ワークフローの作成日
 created string

ワークフローが作成された日
ワークフローの説明
 description string

このワークフローの作成時に指定された説明
ワークフローの表示名
 displayName string

ワークフローの表示名
expirationInfo
 expirationInfo ExpirationFieldInfoDescriptionV6

有効期限に関する情報を含む JSON
ファイル情報
 fileInfos array of FileInfosDescriptionV6

契約作成要求のファイル情報入力フィールドに関する情報
localeInfo
 localeInfo LocaleFieldInfoDescriptionV6

ワークフロー ロケールに関する詳細情報を含む JSON
フィールド情報のマージ
 mergeFieldsInfo array of MergeFieldInfoDescriptionV6

契約作成要求のユーザー設定情報入力フィールドに関する情報
messageInfo
 messageInfo WorkflowDefaultParamsV6

ワークフローの既定の params オブジェクトを含む JSON
変更日
 modified string

ワークフローが最後に変更された日
ワークフロー名
 name string

ワークフローの名前
passwordInfo
 passwordInfo PasswordFieldInfoDescriptionV6

パスワードに関する詳細情報を含む JSON
受信者リスト情報
 recipientsListInfo array of RecipientsListInfoDescriptionV6

契約作成要求の recepients 情報入力フィールドに関する情報
ワークフロー スコープ
 scope string

ワークフロー スコープ
ワークフローの状態
 status string

ワークフローの状態
ワークフロー発信者 ID
 originatorId string

ワークフローの最初の発信元
ワークフロー スコープ ID
 scopeId string

スコープの識別子。 現在、スコープ GROUP にのみ適用され、値は groupId になります

BooleanSettingInfoV6

名前 パス 型 説明
価値
 value boolean

設定の値
継承済み
 inherited boolean

True の場合、設定は、そのグループまたはアカウントの値から継承されます。

SettingsInfoV6

名前 パス 型 説明
libaryDocumentCreationVisible
 libaryDocumentCreationVisible BooleanSettingInfoV6
sendRestrictedToWorkflows
 sendRestrictedToWorkflows BooleanSettingInfoV6
userCanSend
 userCanSend BooleanSettingInfoV6
widgetCreationVisible
 widgetCreationVisible BooleanSettingInfoV6

UserGroupInfoV6

名前 パス 型 説明
グループ識別子
 id string

グループの一意識別子
グループ管理者
 isGroupAdmin boolean

ユーザーがグループ管理者の場合は True
プライマリ グループ
 isPrimaryGroup boolean

True グループがユーザーのプライマリ グループの場合
ステータス
 status string

グループ メンバーシップの状態
作成日
 createdDate date

日付グループが作成されました
グループ名
 name string

グループの名前
設定
 settings SettingsInfoV6

UserGroupsInfoV6

特定のユーザーのグループの一覧を含む JSON

名前 パス 型 説明
ユーザー グループの一覧
 groupInfoList array of UserGroupInfoV6

ユーザー グループ情報項目の配列

AgreementViews

契約ビューの一覧

名前 パス 型 説明
契約ビューの一覧
 agreementViewList array of AgreementView

契約ビュー

AgreementView

必要なビューの名前とその必要な構成。

名前 パス 型 説明
URL の表示
 url string

リソースの場所の URL
埋め込みコード
 embeddedCode string

リソースの URL の埋め込みコード
Expiration
 expiration string

ユーザー URL の有効期限
現在のビュー
 isCurrent boolean

True の 場合、このビューは現在のビューです。

binary

これは基本的なデータ型 'binary' です。

オブジェクト

これは型 'object' です。

ファイル

これは基本的なデータ型 'file' です。