Adobe Acrobat Sign

  • リファレンス

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

このコネクタは、次の製品および地域で利用可能です。

サービス クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate Standard 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps Standard 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Adobe Acrobat Sign サポート
[URL] https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
メール support@echosign.zendesk.com
Connector Metadata
発行者 Adobe Inc.
Web サイト https://acrobat.adobe.com/us/en/sign.html
プライバシー ポリシー https://www.adobe.com/privacy/policy.html
カテゴリ Web サイト

Adobe Sign コネクタを使用するには、このリンクを使用して新しい試用アカウントを作成してください。 コネクタを使用するために必要なすべての権利があります。

それでも接続の作成に問題がある場合は、support@echosign.zendesk.com にお問い合わせください。

既知の問題と制限事項

  1. Adobe API の詳細により、接続を作成したユーザー以外のユーザーにより契約が作成された場合、アクション 契約のフォーム フィールドのデータを取得する が機能しない可能性があります。

調整制限

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

アクション

すべての 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 から契約を作成し、署名用に送信します

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

この操作により、ドキュメント 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 をフェッチします。
契約からドキュメントを取得する

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

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

この操作では、契約の特定のドキュメントのファイル ストリームをフェッチします。
契約のフォーム フィールド データを CSV 形式で取得する

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

契約の対話型フォーム フィールドに入力されたデータを取得します。
契約のフォーム フィールドのデータを取得する (旧) [非推奨]

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

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

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

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

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

パスが含む agreementId で識別した契約をキャンセルします。
検索条件を基にすべての契約の一覧を取得する

この操作により、ワークフロー ID などの条件で契約が検索されます。
署名 URL を取得する

この操作では、契約の現在の署名者の電子署名ページの URL を取得します。
署名された契約書の PDF を入手する

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

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

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

すべての Web フォームのリストを取得する

操作 ID:
GetAllWebForms

この操作は、ユーザーのすべての Web フォームのリストを取得します。

パラメーター

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

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

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

Body
userWidgetListV6

すべてのライブラリ テンプレートのリストを取得します

操作 ID:
GetLibraryDocuments_V2

この操作を実行すると、テンプレートとして保存されているすべてのドキュメントのリストが、ユーザーの Adobe Acrobat Sign ライブラリでフェッチされます。

パラメーター

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

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

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

Body
LibraryDocuments

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

操作 ID:
GetLibraryDocuments

この操作を実行すると、テンプレートとして保存されているすべてのドキュメントのリストが、ユーザーの Adobe Acrobat Sign ライブラリでフェッチされます。

戻り値

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

Body
DocumentLibraryItems

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

操作 ID:
GetAllWorkflows

この操作を実行すると、ユーザーのすべてのワークフローが取得されます。

パラメーター

名前 キー 必須 型 説明
ドラフト ワークフローを含める
 includeDraftWorkflows boolean

ドラフト ワークフローを含める
非アクティブなワークフローを含める
 includeInactiveWorkflows boolean

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

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

Body
userWorkflowListV6

すべての契約のリストを取得します

操作 ID:
GetAllAgreements_V2

この操作を実行すると、ユーザーのすべての契約のリストが取得されます。

パラメーター

名前 キー 必須 型 説明
カーソル
 cursor string

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

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

Body
userAgreementListV6

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

操作 ID:
GetAllAgreements

この操作を実行すると、ユーザーのすべての契約のリストが取得されます。

戻り値

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

本文​​
UserAgreements

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

操作 ID:
CreateLibraryDocumentById_V2

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

パラメーター

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

次の形式による API 呼び出し元のメール: email: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。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

ライブラリ テンプレートを説明する 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 オブジェクト

本文​​
LibraryDocumentCreationResponse

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

操作 ID:
CreateAgreementById_V2

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

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
契約名
 name True string

契約の名前
ID
 transientDocumentId True string

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

リクエストする署名の種類 - 電子署名または書面
参加者の電子メール
 email True string

参加者の電子メール
認証
 authenticationMethod string

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

参加者に対してパスワードを必須にする
国番号
 countryCode string

ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です
電話番号。
 phone string

契約書の表示と署名を行う際に必要な受信者の電話番号
並べ替え
 order True integer

インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。
役割
 role True string

関係者が設定した現在のロール (署名者、承認者など) です。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります
Message
 message string

アクションを要求する受信者に対するオプションのメッセージ
電子メール
 email string

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

契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z
アラームの頻度
 reminderFrequency string

通知を送信する頻度を指定してください。
ドキュメントのパスワード
 openPassword string

署名済み契約 PDF を暗号化するために使用するパスワード
件名
 fieldName string

フィールドの名前
値
 defaultValue string

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

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

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

契約開始イベントの通知メールを管理します。

戻り値

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

Body
AgreementCreationResponseV6

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

操作 ID:
CreateAgreementById

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

パラメーター

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

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

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

リクエストする署名の種類 - 電子署名または書面
受信者の電子メール
 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

本文​​
AgreementCreationResponse

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

操作 ID:
CreateLibraryDocumentByUrl_V2

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

パラメーター

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

次の形式による API 呼び出し元のメール: email: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 の種類 (例: アプリケーション/pdf)
テンプレートの状態
 state True string

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

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

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

Body
LibraryDocumentCreationResponseV6

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

操作 ID:
CreateAgreementByUrl_V2

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

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
契約名
 name True string

契約の名前
[URL]
 url True string

未処理のファイル コンテンツを取得するための外部にアクセス可能な URL
件名
 name True string

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

参照先ファイルの MIME の種類 (例: アプリケーション/pdf)
署名の種類
 signatureType True string

電子署名または書面で要求された署名の種類を指定します
参加者の電子メール
 email True string

参加者の電子メール
認証
 authenticationMethod string

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

参加者に対してパスワードを必須にする
国番号
 countryCode string

ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です
電話番号。
 phone string

契約書の表示と署名を行う際に必要な受信者の電話番号
並べ替え
 order True integer

インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。
役割
 role True string

関係者が設定した現在のロール (署名者、承認者など) です。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります
Message
 message string

アクションを要求する受信者に対するオプションのメッセージ
電子メール
 email string

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

契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z
アラームの頻度
 reminderFrequency string

通知を送信する頻度を指定してください。
ドキュメントのパスワード
 openPassword string

署名済み契約 PDF を暗号化するために使用するパスワード
件名
 fieldName string

フィールドの名前
値
 defaultValue string

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

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

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

契約開始イベントの通知メールを管理します。

戻り値

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

Body
AgreementCreationResponseV6

ドキュメントの 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 オブジェクト

本文​​
LibraryDocumentCreationResponse

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

操作 ID:
CreateAgreementByUrl

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

パラメーター

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

契約の名前
URL
 url True string

ドキュメントを取得するための一般にアクセス可能な URL
件名
 name True string

参照された拡張子付きドキュメントの名前
署名の種類
 signatureType True string

リクエストする署名の種類 - 電子署名または書面
受信者の電子メール
 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

本文​​
AgreementCreationResponse

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

操作 ID:
CreateTransientDocument

この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、そのドキュメント ID を返します。 このドキュメントは一時的に Adobe Acrobat Sign に保存され、契約の作成などの他の操作にドキュメント ID を使用することができます。

パラメーター

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

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

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

戻り値

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

本文​​
TransientDocumentResponse

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

操作 ID:
CreateTransientDocument_V2

この操作により、Adobe Acrobat Sign アカウントにドキュメントがアップロードされ、そのドキュメント ID を返します。 このドキュメントは一時的に Adobe Acrobat Sign に保存され、契約の作成などの他の操作にドキュメント ID を使用することができます。

パラメーター

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

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

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

Body
TransientDocumentResponse

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

操作 ID:
CreateAgreementByFileStream

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

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
契約名
 name True string

契約の名前
件名
 fileName True string

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

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

リクエストする署名の種類 - 電子署名または書面
参加者の電子メール
 email True string

参加者の電子メール
認証
 authenticationMethod string

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

参加者に対してパスワードを必須にする
国番号
 countryCode string

ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です
電話番号。
 phone string

契約書の表示と署名を行う際に必要な受信者の電話番号
並べ替え
 order True integer

インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。
役割
 role True string

関係者が設定した現在のロール (署名者、承認者など) です。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります
Message
 message string

アクションを要求する受信者に対するオプションのメッセージ
電子メール
 email string

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

契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z
アラームの頻度
 reminderFrequency string

通知を送信する頻度を指定してください。
ドキュメントのパスワード
 openPassword string

署名済み契約 PDF を暗号化するために使用するパスワード
件名
 fieldName string

フィールドの名前
値
 defaultValue string

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

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

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

契約開始イベントの通知メールを管理します。

戻り値

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

Body
AgreementCreationResponseV6

ユーザーが所属するすべてのグループのリストを取得する

操作 ID:
GetAllUserGroups

この操作は、ユーザーが属するすべてのグループのリストを取得します。

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
User ID
 userId True string

許可されているユーザーの結果を取得するには、ユーザー ID を引用符なしで 'me' に置き換えることができます。

戻り値

指定されたユーザーのグループのリストを含む JSON

Body
UserGroupsInfoV6

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

操作 ID:
CreateAgreementByTemplate_V2

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

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
契約名
 name True string

契約の名前
Template
 libraryDocumentId True string

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

リクエストする署名の種類 - 電子署名または書面
参加者の電子メール
 email True string

参加者の電子メール
認証
 authenticationMethod string

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

参加者に対してパスワードを必須にする
国番号
 countryCode string

ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です
電話番号。
 phone string

契約書の表示と署名を行う際に必要な受信者の電話番号
並べ替え
 order True integer

インデックスは 1 から始まり、署名するグループが署名する必要がある場所を示します。
役割
 role True string

関係者が設定した現在のロール (署名者、承認者など) です。
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります
Message
 message string

アクションを要求する受信者に対するオプションのメッセージ
電子メール
 email string

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

契約期限が切れてからの時間です。 例: 2020-12-31T23:59:00Z
アラームの頻度
 reminderFrequency string

通知を送信する頻度を指定してください。
ドキュメントのパスワード
 openPassword string

署名済み契約 PDF を暗号化するために使用するパスワード
件名
 fieldName string

フィールドの名前
値
 defaultValue string

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

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

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

契約開始イベントの通知メールを管理します。

戻り値

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

Body
AgreementCreationResponseV6

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

操作 ID:
CreateAgreementByTemplate

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

パラメーター

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

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

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

リクエストする署名の種類 - 電子署名または書面
受信者の電子メール
 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

本文​​
AgreementCreationResponse

ワークフローから契約を作成し、署名用に送信する

操作 ID:
CreateAgreementFromWorkflow

この操作により、Adobe Acrobat Sign のワークフローから契約が作成され、シグネチャ用に送信されます。

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId True string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります
ワークフロー名/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 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります

戻り値

ワークフローに関する詳細情報を含む JSON

Body
WorkflowDescriptionV6

契約からすべてのドキュメント ID の一覧を取得する

操作 ID:
GetAllDocumentsofAnAgreement_V2

この操作では、契約のすべてのドキュメントとサポート ドキュメントの ID をフェッチします。

パラメーター

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

ドキュメントが必要な契約の契約 ID
サポート ドキュメント - コンテンツ タイプ
 supportingDocumentContentFormat string

契約のサポート ドキュメントのコンテンツ タイプ
の名前で
 x-api-user string

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON

Body
AgreementDocumentsV6

契約からすべてのドキュメント ID の一覧を取得する [非推奨]

操作 ID:
GetAllDocumentsofAnAgreement

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

この操作では、契約のすべてのドキュメントとサポート ドキュメントの ID をフェッチします。

パラメーター

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

ドキュメントが必要な契約の契約 ID
サポート ドキュメント - コンテンツ タイプ
 supportingDocumentContentFormat string

契約のサポート ドキュメントのコンテンツ タイプ

戻り値

ドキュメントとサポート ドキュメントの両方の配列オブジェクトを含む JSON

本文​​
AgreementDocuments

契約からドキュメントを取得する

操作 ID:
GetDocument_V2

この操作では、契約の特定のドキュメントのファイル ストリームをフェッチします。

パラメーター

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

ドキュメントが必要な契約の契約 ID
ドキュメント ID
 documentId True string

契約の特定のドキュメントのドキュメント ID
の名前で
 x-api-user string

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

ドキュメントのファイルストリーム

返答
DocumentResponse

契約からドキュメントを取得する [非推奨]

操作 ID:
GetDocument

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

この操作では、契約の特定のドキュメントのファイル ストリームをフェッチします。

パラメーター

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

ドキュメントが必要な契約の契約 ID
ドキュメント ID
 documentId True string

契約の特定のドキュメントのドキュメント ID

戻り値

ドキュメントのファイルストリーム

応答
DocumentResponse

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

操作 ID:
GetAgreementFormFieldData_V2

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

パラメーター

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

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

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

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

操作 ID:
GetAgreementFormFieldData_V3

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

パラメーター

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

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

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

契約のフォーム フィールドのデータを取得する (旧) [非推奨]

操作 ID:
GetAgreementFormFieldData

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

パラメーター

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

情報が必要な契約の契約 ID

戻り値

応答
file

契約の状態を取得する

操作 ID:
GetAgreementInfo_V2

この操作では、状態など、契約の現在の情報をすべてフェッチします。

パラメーター

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

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

完全な契約の詳細

Body
AgreementInfoV6

契約の状態を取得する [非推奨]

操作 ID:
GetAgreementInfo

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

この操作では、状態など、契約の現在の情報をすべてフェッチします。

パラメーター

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

情報が必要な契約の契約 ID

戻り値

契約に関する詳細

本文​​
AgreementInfo

契約の監査証跡の PDF を入手する

操作 ID:
GetAgreementAuditTrail

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

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
契約 ID
 agreementId True string

情報が必要な契約の契約 ID

戻り値

契約監査証跡のファイル ストリーム

返答
AgreementAuditTrailResponse

契約を取り消す

操作 ID:
CancelAgreement

パスが含む agreementId で識別した契約をキャンセルします。

パラメーター

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

取り消す対象の契約が持つ契約 ID。
の名前で
 x-api-user string

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
契約の状態
 state string

契約を得る必要がある状態です。
コメント
 comment string

受信者にキャンセルの理由を説明するオプションのコメント。
その他
 notifyOthers boolean

受信者に通知するかどうか。

検索条件を基にすべての契約の一覧を取得する

操作 ID:
SearchAgreements

この操作により、ワークフロー ID などの条件で契約が検索されます。

パラメーター

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

次の形式による API 呼び出し元のメール: email:adobesignuser@domain.com
グループ名/ID
 groupId string

グループの ID。 これを使用するには、フィールド '代理する相手' を選択する必要があります
ワークフロー名/ID
 workflowId string

リストからカスタム ワークフローを選択するか、カスタム ワークフロー ID を入力します。
作成後
 gt string

最小の許容する日時。 例: 2020-12-31T23:59:00Z
Created Before
 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 呼び出し元のメール: email: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 呼び出し元のメール: email:adobesignuser@domain.com

戻り値

ドキュメントのファイルストリーム

返答
CombinedDocumentResponse

署名された契約書の PDF を入手する [非推奨]

操作 ID:
GetCombinedDocument

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

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

パラメーター

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

契約を作成したアクションで指定された契約 ID
サポート ドキュメントを添付?
 attachSupportingDocuments boolean

true の場合、署名された契約 PDF にサポート ドキュメントを添付
監査レポートを添付?
 auditReport boolean

true の場合、署名された契約 PDF に監査レポートを添付

戻り値

ドキュメントのファイルストリーム

応答
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 True string

トリガーのスコープ
リソースの種類
 resourceType string

「スコープ」が「特定契約」の場合のみ指定します。 フローをトリガーするリソース タイプを選択します。
リソース ID
 resourceId string

「スコープ」が「特定契約」の場合のみ指定します。 フローをトリガーする契約、メガ サイン、Web フォーム、またはグループ ID を入力します。
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

フローをトリガーするイベント
契約情報を含めますか?
 includeDetailedInfo boolean

詳細な契約情報を通知する必要がありますか?
契約の参加者情報を含めますか?
 includeParticipantsInfo boolean

契約の参加者情報を通知する必要がありますか?
契約ドキュメントの情報を含めますか?
 includeDocumentsInfo boolean

契約ドキュメントの情報を通知する必要がありますか?
契約の署名済みドキュメントの情報を含めますか?
 includeSignedDocuments boolean

契約完了時に署名されたドキュメントの最終コピーを通知する必要がありますか?
MegaSign の情報を含めますか?
 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 の情報を含めますか?
 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

「スコープ」が「特定契約」の場合のみ指定します。 一覧から契約を選択するか、契約 ID を入力します。
サブスクリプション
webhookSubscriptionEvents True array of string

フローをトリガーするイベント
契約情報を含めますか?
 includeDetailedInfo boolean

詳細な契約情報を通知する必要がありますか?
契約の参加者情報を含めますか?
 includeParticipantsInfo boolean

契約の参加者情報を通知する必要がありますか?
契約ドキュメントの情報を含めますか?
 includeDocumentsInfo boolean

契約ドキュメントの情報を通知する必要がありますか?

戻り値

本文​​
WebhookPayload

契約の状態を変更するとき

操作 ID:
CreateWebhookForAgreementStatusUpdated

契約の状態が変更されると新しいフローをトリガーします。 作成、完了など、最も一般的な契約イベントをカバーします。

パラメーター

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

トリガーの名前
Scope
 scope True string

トリガーのスコープ
契約名/ID
 resourceId string

「スコープ」が「特定契約」の場合のみ指定します。 一覧から契約を選択するか、契約 ID を入力します。
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

フローをトリガーするイベント
契約情報を含めますか?
 includeDetailedInfo boolean

詳細な契約情報を通知する必要がありますか?
契約の参加者情報を含めますか?
 includeParticipantsInfo boolean

契約の参加者情報を通知する必要がありますか?
契約ドキュメントの情報を含めますか?
 includeDocumentsInfo boolean

契約ドキュメントの情報を通知する必要がありますか?
契約の署名済みドキュメントの情報を含めますか?
 includeSignedDocuments boolean

契約完了の通知の際に、署名されたドキュメントの最終コピーを送信する必要がありますか?

戻り値

Body
WebhookPayloadWithSignedDocumentForStatusChange

契約ワークフローが正常に完了したとき

操作 ID:
CreateWebhookForAgreementSignedEvent

契約ワークフローが正常に完了したときに新しいフローをトリガーします

パラメーター

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

トリガーの名前
Scope
 scope True string

トリガーのスコープ
契約名/ID
 resourceId string

「スコープ」が「特定契約」の場合のみ指定します。 一覧から契約を選択するか、契約 ID を入力します。
サブスクリプション
webhookSubscriptionEvents True array of string

フローをトリガーするイベント
契約情報を含めますか?
 includeDetailedInfo boolean

詳細な契約情報を通知する必要がありますか?
契約の参加者情報を含めますか?
 includeParticipantsInfo boolean

契約の参加者情報を通知する必要がありますか?
契約ドキュメントの情報を含めますか?
 includeDocumentsInfo boolean

契約ドキュメントの情報を通知する必要がありますか?
契約の署名済みドキュメントの情報を含めますか?
 includeSignedDocuments boolean

契約完了時に署名されたドキュメントの最終コピーを通知する必要がありますか?

戻り値

本文​​
WebhookPayloadWithSignedDocument

新しい契約が作成される場合

操作 ID:
CreateWebhookForAgreementCreatedEvent

新しい契約が作成された時に、新しいフローをトリガーします。

パラメーター

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

トリガーの名前
範囲
 scope True string

トリガーのスコープ
サブスクリプション
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

電子署名または書面で要求された署名の種類を指定します
ドキュメント保護
 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

電子署名または書面で要求された署名の種類を指定します
セキュリティのオプション
 securityOptions string

ドキュメントの表示と署名にパスワードが必要かどうかを指定する、ドキュメントに関するセキュリティ情報
ステータス
 status string

契約の現在の状態
送信者の電子メール
 senderEmail string

送信者の電子メール
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID です。
CC
 ccs array of CcInfo

契約トランザクションでコピーされる 1 つ以上の CC の一覧。
Group ID
 groupId string

契約が属しているグループの一意識別子。

CombinedDocumentResponse

ドキュメントのファイルストリーム

ドキュメントのファイルストリーム

ファイル内容
binary

AgreementAuditTrailResponse

契約監査証跡のファイル ストリーム

契約監査証跡のファイル ストリーム

契約監査証跡の内容
binary

DisplayUserInfo

名前 パス 型 説明
Company
 company string

ユーザーの会社名を表示 (可能な場合)
電子メール
 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 string

次の参加者の電子メール アドレス
件名
 name string

次の参加者の名前 (可能な場合)
待機時間
 waitingSince date

ドキュメントが参加者のアクションを待機してからの日付

NextParticipantSetInfo

名前 パス 型 説明
次の参加者セット メンバーの情報
 nextParticipantSetMemberInfos array of NextParticipantInfo

次の参加者セットのメンバーに関する情報

ParticipantInfo

名前 パス 型 説明
会社
 company string

参加者の会社 (可能な場合)
電子メール
 email string

参加者の電子メール アドレス
件名
 name string

参加者の名前 (可能な場合)
参加者 ID
 participantId string

参加者の一意の ID
セキュリティのオプション
 securityOptions array of string

参加者に適用されるセキュリティのオプション
敬称
 title string

参加者の敬称 (可能な場合)

ParticipantSetInfo

名前 パス 型 説明
参加者セットの ID
 participantSetId string

参加者セットの一意の ID
参加者セット メンバーの情報
 participantSetMemberInfos array of ParticipantInfo

受信者セットのメンバーに関する情報
プライベート メッセージ
 privateMessage string

セット内の参加者のプライベート メッセージ
役割
 roles array of string

参加者セットの現在のロールです。 参加者セットは 1 つ以上のロールを持つことができる
securityOptions
 securityOptions array of string

参加者に適用されるセキュリティのオプション
署名の順序
 signingOrder integer

この受信者が署名する順序を示す 1 で始まるインデックス
参加者セットの状態
 status string

ドキュメントに対する参加者セットの状態

ParticipantSetInfoV6

名前 パス 型 説明
参加者セット メンバーの情報
 memberInfos array of MemberInfosV6

受信者セットのメンバーに関する情報
並べ替え
 order integer

署名するグループが署名する必要がある場所を示すインデックスです。
役割
 role string

関係者が設定した現在のロール (署名者、承認者など) です。
参加者セット名
 name string

参加者セットの名前
参加者セットのプライベート メッセージ
 privateMessage string

セット内の参加者のプライベート メッセージ
参加者セット表示ページ
 visiblePages array of string

参加者セットに表示されるページ

MemberInfosV6

名前 パス 型 説明
参加者の電子メール
 email string

参加者の電子メール
認証
 securityOption.authenticationMethod string

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

参加者に対してパスワードを必須にする
国番号
 securityOption.phoneInfo.countryCode string

ドキュメントの表示と署名を行う際には、受信者の電話番号に国コードが必要です
電話番号。
 securityOption.phoneInfo.phone string

契約書の表示と署名を行う際に必要な受信者の電話番号

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 boolean

これが電子署名ドキュメントである場合は True
最新バージョン ID
 latestVersionId string

契約の現在のバージョンを一意に識別するバージョン ID
件名
 name string

契約の名前
ステータス
 status string

契約の現在の状態

UserAgreements

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

名前 パス 型 説明
契約リスト
 userAgreementList array of UserAgreement

契約項目の配列

UserAgreementV6

名前 パス 型 説明
ユーザー セット情報の表示
 displayParticipantSetInfos array of DisplayUserSetInfo

契約に最も関連性の高い現在のユーザー セットです。 通常、現在のユーザーからの契約であれば次の署名者、他のユーザーからの契約であれば送信者
日付の表示
 displayDate string

契約の表示日
電子署名
 esign boolean

これが電子署名ドキュメントである場合は True
非表示
 hidden boolean

ユーザーに対して契約が非表示の場合は True
グループ ID
 groupId string

グループを表す一意の識別子
最新バージョン ID
 latestVersionId string

契約の現在のバージョンを一意に識別するバージョン ID
件名
 name string

契約の名前
Parent ID
 parentId string

megaSign の子の親 ID、または Web フォームの契約インスタンスの元になる ID
契約 ID
 id string

契約を表す一意の識別子
ステータス
 status string

契約の現在の状態
タイプ
 type string

契約の種類

userAgreementListV6

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

名前 パス 型 説明
ページ
 page page

応答内の移動のための改ページ情報
契約リスト
 userAgreementList array of UserAgreementV6

契約項目の配列

ページ

応答内の移動のための改ページ情報

名前 パス 型 説明
nextCursor
 nextCursor string

次のページに移動するときに使用されます。 返されない場合は、それ以上のページはありません。

WebhookPayload

名前 パス 型 説明
イベント
 event string

リソースで発生したイベントです。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
イベントのリソースの種類
 eventResourceType string

イベントが発生したリソースです。
契約の親の種類
 eventResourceParentType string

契約が作成されたリソースに関する情報です。 指定できる値: Web フォームまたは メガ サイン
契約の親の ID
 eventResourceParentId string

この契約が作成されたリソースの一意の ID
イベント参加者ロール
 participantRole string

イベントの参加者のロールです。
イベント参加者 ID
 participantUserId string

イベントの参加者の IDです。
イベント参加者電子メール
 participantUserEmail string

イベントの参加者の電子メールです。
イベント アクティング ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID です。
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfo

契約の詳細情報

ApplicableUsers

この通知が適用されるユーザーに関する情報

名前 パス 型 説明
通知適用対象ユーザー ID
 id string

この通知が適用されるユーザーの一意の ID
通知適用対象ユーザーの電子メール
 email string

この通知が適用されるユーザーの電子メール
通知適用対象ユーザーのロール
 role string

この通知が生成されるワークフローでのユーザーのロール
ペイロード適用対象ユーザーか
 payloadApplicable boolean

この通知で提供されるデータがこのユーザーに適用されるかどうか

WebhookPayloadWithoutNextParticipantSet

名前 パス 型 説明
イベント
 event string

リソースで発生したイベントです。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
イベントのリソースの種類
 eventResourceType string

イベントが発生したリソースです。
契約の親の種類
 eventResourceParentType string

契約が作成されたリソースに関する情報です。 指定できる値: Web フォームまたは メガ サイン
契約の親の ID
 eventResourceParentId string

この契約が作成されたリソースの一意の ID
イベント参加者 ID
 participantUserId string

イベントの参加者の IDです。
イベント参加者電子メール
 participantUserEmail string

イベントの参加者の電子メールです。
イベント アクティング ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfoWithoutNextParticipantSet

契約の詳細情報

WebhookPayloadWithSignedDocumentForStatusChange

名前 パス 型 説明
イベント
 event string

リソースで発生したイベントです。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
サブ イベント
 subEvent string

リソースで発生したサブ イベントです。
契約の親の種類
 eventResourceParentType string

契約が作成されたリソースに関する情報です。 指定できる値: Web フォームまたは メガ サイン
契約の親の ID
 eventResourceParentId string

この契約が作成されたリソースの一意の ID
イベント参加者 ID
 participantUserId string

イベントの参加者の IDです。
イベント参加者電子メール
 participantUserEmail string

イベントの参加者の電子メールです。
イベント アクティング ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
アクションの種類
 actionType string

イベントが発生したアクションです。
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
イベントのリソースの種類
 eventResourceType string

イベントが発生したリソースです。
イベント参加者ロール
 participantRole string

イベントの参加者のロールです。
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfoWithSignedDocument

契約の詳細情報

WebhookPayloadWithSignedDocument

名前 パス 型 説明
イベント
 event string

リソースで発生したイベントです。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
契約の親の種類
 eventResourceParentType string

契約が作成されたリソースに関する情報です。 指定できる値: Web フォームまたは メガ サイン
契約の親の ID
 eventResourceParentId string

この契約が作成されたリソースの一意の ID
イベントのリソースの種類
 eventResourceType string

イベントが発生したリソースです。
イベント参加者ロール
 participantRole string

イベントの参加者のロールです。
イベント参加者 ID
 participantUserId string

イベントの参加者の IDです。
イベント参加者電子メール
 participantUserEmail string

イベントの参加者の電子メールです。
イベント アクティング ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfoWithSignedDocument

契約の詳細情報

WebhookPayloadGeneric

名前 パス 型 説明
イベント
 event string

リソースで発生したイベントです。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
サブ イベント
 subEvent string

リソースで発生したサブ イベントです。
契約の親の種類
 eventResourceParentType string

契約が作成されたリソースに関する情報です。 指定できる値: Web フォームまたは メガ サイン
契約の親の ID
 eventResourceParentId string

この契約が作成されたリソースの一意の ID
イベントのリソースの種類
 eventResourceType string

イベントが発生したリソースです。
イベント参加者ロール
 participantRole string

イベントの参加者のロールです。
イベント参加者 ID
 participantUserId string

イベントの参加者の IDです。
イベント参加者電子メール
 participantUserEmail string

イベントの参加者の電子メールです。
イベント アクティング ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
アクションの種類
 actionType string

イベントが発生したアクションです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の詳細情報
メガ サイン
 megaSign WebhookMegaSignInfo

メガ サインの詳細情報
Web フォーム
 widget WebhookWidgetInfo

Web フォームの完全な情報

WebFormWebhookAgreementEventPayload

名前 パス 型 説明
イベント
 event string

Web フォームで発生した契約イベント。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
サブ イベント
 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 です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
アクションの種類
 actionType string

イベントが発生したアクションです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の詳細情報

GroupWebhookEventPayload

名前 パス 型 説明
イベント
 event string

グループで発生したイベント。
イベントの日付
 eventDate date

イベントの日付です。 形式は yyyy-MM-dd'T'HH:mm:ssZ。 (例: 2016-02-25T18:46:19Z は UTC 時間を表す)
サブ イベント
 subEvent string

グループで発生したサブ イベント。
契約の親タイプ - Web フォーム
 eventResourceParentType string

契約が作成されたグループに関する情報。
Web フォーム ID
 eventResourceParentId string

この契約が作成されたグループの一意の ID
イベント リソース タイプ - 契約
 eventResourceType string

イベントが発生したグループ。
イベント参加者ロール
 participantRole string

イベントの参加者のロールです。
イベント参加者 ID
 participantUserId string

イベントの参加者の IDです。
イベント参加者電子メール
 participantUserEmail string

イベントの参加者の電子メールです。
イベント アクティング ユーザー ID
 actingUserId string

イベントを作成したユーザーの ID です。
イベント アクティング ユーザーの電子メール
 actingUserEmail string

イベントを作成したユーザーの電子メールです。
イベント開始ユーザー ID
 initiatingUserId string

アクティング ユーザーに代わってイベントを開始したユーザーの ID
イベント開始ユーザーの電子メール
 initiatingUserEmail string

アクティング ユーザーに代わってイベントを開始したユーザーの電子メールです。
アクションの種類
 actionType string

イベントが発生したアクションです。
イベント アクティング ユーザー IP アドレス
 actingUserIpAddress string

イベントを作成したユーザーの IP アドレス
通知適用対象ユーザー
 webhookNotificationApplicableUsers array of ApplicableUsers

この通知が適用対象のユーザーの一覧
契約
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の詳細情報
メガ サイン
 megaSign WebhookMegaSignInfo

メガ サインの詳細情報
Web フォーム
 widget WebhookWidgetInfo

Web フォームの完全な情報

WebhookAgreementInfo

契約の詳細情報

名前 パス 型 説明
ID
 id string

契約の一意の ID
件名
 name string

契約の名前
署名の種類
 signatureType string

電子署名または書面で要求された署名の種類を指定します
ステータス
 status string

契約の現在の状態
CC
 ccs array of CcInfo

契約トランザクションでコピーされる 1 つ以上の CC の一覧。
作成日
 createdDate date

契約が作成された日付
有効期限
 expirationTime string

契約の有効期限が切れる前に必要な署名をするまでの時間
外部 ID
 externalId.id string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
外部グループ
 externalId.group string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
最初のアラームの遅延
 firstReminderDelay integer

最初のアラームを送信するまでの遅延を時間単位で指定する整数です。
ロケール
 locale string

この契約に関連付けられているロケール
メッセージ
 message string

送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ
アラームの頻度
 reminderFrequency string

参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用
送信者の電子メール
 senderEmail string

契約の送信者の電子メール
Vault は有効か?
 vaultingInfo.enabled boolean

ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する
ドキュメントの可視性?
 documentVisibilityEnabled boolean

ドキュメントの可視性は有効になっているか
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID です。
ポスト サインのリダイレクト URL
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL
参加者セット
 participantSetsInfo.participantSets array of WebhookParticipantSets

参加者セット情報
次の参加者セット
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

次の参加者セット情報
ドキュメント​
 documentsInfo.documents array of WebhookDocument

ドキュメントを表すオブジェクトの一覧
サポート ドキュメント
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

サポート ドキュメントの一覧

WebhookAgreementInfoWithoutNextParticipantSet

契約の詳細情報

名前 パス 型 説明
ID
 id string

契約の一意の ID
件名
 name string

契約の名前
署名の種類
 signatureType string

電子署名または書面で要求された署名の種類を指定します
ステータス
 status string

契約の現在の状態
CC
 ccs array of CcInfo

契約トランザクションでコピーされる 1 つ以上の CC の一覧。
作成日
 createdDate date

契約が作成された日付
ドキュメントの可視性?
 documentVisibilityEnabled boolean

ドキュメントの可視性は有効になっているか
有効期限
 expirationTime string

契約の有効期限が切れる前に必要な署名をするまでの時間
外部 ID
 externalId.id string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
外部グループ
 externalId.group string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
最初のアラームの遅延
 firstReminderDelay integer

最初のアラームを送信するまでの遅延を時間単位で指定する整数です。
ロケール
 locale string

この契約に関連付けられているロケール
メッセージ
 message string

送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ
アラームの頻度
 reminderFrequency string

参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用
送信者の電子メール
 senderEmail string

契約の送信者の電子メール
Vault は有効か?
 vaultingInfo.enabled boolean

ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する
ポスト サインのリダイレクト URL
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID です。
参加者セット
 participantSetsInfo.participantSets array of WebhookParticipantSets

参加者セット情報

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

契約の詳細情報

名前 パス 型 説明
ID
 id string

契約の一意の ID
件名
 name string

契約の名前
署名の種類
 signatureType string

電子署名または書面で要求された署名の種類を指定します
ステータス
 status string

契約の現在の状態
CC
 ccs array of CcInfo

契約トランザクションでコピーされる 1 つ以上の CC の一覧。
作成日
 createdDate date

契約が作成された日付
有効期限
 expirationTime string

契約の有効期限が切れる前に必要な署名をするまでの時間
外部 ID
 externalId.id string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
外部グループ
 externalId.group string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
最初のアラームの遅延
 firstReminderDelay integer

最初のアラームを送信するまでの遅延を時間単位で指定する整数です。
ロケール
 locale string

この契約に関連付けられているロケール
メッセージ
 message string

送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ
アラームの頻度
 reminderFrequency string

参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用
ポスト サインのリダイレクト URL
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID です。
送信者の電子メール
 senderEmail string

契約の送信者の電子メール
ドキュメントの可視性?
 documentVisibilityEnabled boolean

ドキュメントの可視性は有効になっているか
Vault は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する
参加者セット
 participantSetsInfo.participantSets array of WebhookParticipantSets

参加者セット情報
次の参加者セット
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

次の参加者セット情報
ドキュメント​
 documentsInfo.documents array of WebhookDocument

ドキュメントを表すオブジェクトの一覧
サポート ドキュメント
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

サポート ドキュメントの一覧。これは、契約にサポート ドキュメントがある場合のみ返される
署名されたドキュメント情報
 signedDocumentInfo.document string

署名されたドキュメントの Base64 エンコード文字列

WebhookAgreementInfoWithSignedDocument

契約の詳細情報

名前 パス 型 説明
ID
 id string

契約の一意の ID
件名
 name string

契約の名前
署名の種類
 signatureType string

電子署名または書面で要求された署名の種類を指定します
ステータス
 status string

契約の現在の状態
CC
 ccs array of CcInfo

契約トランザクションでコピーされる 1 つ以上の CC の一覧
作成日
 createdDate date

契約が作成された日付
ドキュメントの可視性?
 documentVisibilityEnabled boolean

ドキュメントの可視性は有効になっているか
有効期限
 expirationTime string

契約の有効期限が切れる前に必要な署名をするまでの時間
外部 ID
 externalId.id string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
外部グループ
 externalId.group string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
最初のアラームの遅延
 firstReminderDelay integer

最初のアラームを送信するまでの遅延を時間単位で指定する整数です。
ロケール
 locale string

この契約に関連付けられているロケール
メッセージ
 message string

送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ
アラームの頻度
 reminderFrequency string

参加者にアラームを送信する頻度を設定するオプションのパラメーターです。 指定されていない場合、アカウントに設定されているデフォルトの頻度を使用
送信者の電子メール
 senderEmail string

契約の送信者の電子メール
Vault は有効か?
 vaultingInfo.enabled boolean

ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する
ポスト サインのリダイレクト URL
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL
ワークフロー ID
 workflowId string

契約のルーティング パスを定義するカスタム ワークフローの ID です。
参加者セット
 participantSetsInfo.participantSets array of WebhookParticipantSets

参加者セット情報
ドキュメント​
 documentsInfo.documents array of WebhookDocument

ドキュメントを表すオブジェクトの一覧
サポート ドキュメント
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

サポート ドキュメントの一覧。これは、契約にサポート ドキュメントがある場合のみ返される
署名されたドキュメント情報
 signedDocumentInfo.document string

署名されたドキュメントの Base64 エンコード文字列

WebhookMegaSignInfo

メガ サインの詳細情報

名前 パス 型 説明
ID
 id string

megasign の一意 ID
件名
 name string

megasign の名前
ステータス
 status string

megasign の状態
CC
 ccs array of MegaSignCcInfo

この megasign にコピーする 1 つ以上の電子メール アドレスの一覧です。
外部 ID
 externalId.id string

送信時に指定され、後に返されたりクエリを実行されたりする、システムからの任意の値
最初のアラームの遅延
 firstReminderDelay integer

最初のアラームを送信するまでの遅延を時間単位で指定する整数です。
ロケール
 locale string

この契約に関連付けられているロケール
メッセージ
 message string

送信内容や署名が必要な理由を説明する、参加者へのオプションのメッセージ
ポスト サインのリダイレクト URL
 postSignOption.redirectUrl string

署名プロセスが正常に完了した後にユーザーが送信される、一般にアクセス可能な URL
送信者の電子メール
 senderEmail string

megasign 作成者の電子メール
署名の種類
 signatureType string

電子署名または書面で要求された署名の種類を指定します
Vault は有効ですか?
 vaultingInfo.enabled boolean

ドキュメントの保管が設定されているアカウントで、契約ごとに有効にするオプションがある場合、ドキュメントを保管するかどうかを決定する
子契約ファイル情報
 childAgreementsInfo.fileInfo MegaSignChildAgreementsFileInfo

megaSign の子ごとの契約情報を含むファイル情報です。

WebhookWidgetInfo

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 フォームの作成者のメール アドレス
Vault は有効か?
 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

ユーザーが結果ページに移動するまでの遅延時間 (秒)
認証エラーのリダイレクト デフレーム
 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 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 string

Web フォームの CC 参加者のメール

MegaSignCcInfo

メガ サインの CC に関する情報

名前 パス 型 説明
電子メール
 email string

megasign の CC 参加者の電子メール

CcInfo

契約の CC に関する情報

名前 パス 型 説明
電子メール
 email string

契約の CC の電子メール
Label
 label string

ワークフローの説明で返される CC リストのラベル
表示ページ
 visiblePages array of string

CC に表示されるページ

WidgetParticipantSetInfo

名前 パス 型 説明
役割
 role string

セット内のすべての参加者 (署名者、承認者など) が担うロール
ID
 id string

参加者セットの一意の識別子
メンバー情報
 memberInfos array of MemberInfos

参加者メンバーに関する情報
並べ替え
 order integer

連続する署名グループを示すインデックス (ハイブリッド ルーティング用に指定)

MemberInfos

名前 パス 型 説明
ID
 id string

参加者の一意の ID
電子メール
 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

ライブラリ ドキュメントの作成者のメール アドレスです。
グループ ID
 groupId string

ライブラリ テンプレートが属しているグループを表す一意識別子です。
ステータス
 status string

ライブラリ セクションの状態

LibraryDocuments

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

名前 パス 型 説明
ページ
 page page

応答内の移動のための改ページ情報
ライブラリ テンプレート リスト
 libraryDocumentList array of LibraryDocument

ライブラリ テンプレート項目のリスト

UserWidgetV6

名前 パス 型 説明
Web フォーム ID
 id string

Web フォームを表す一意識別子
変更日
 modifiedDate string

Web フォームを最後に変更した日付
非表示
 hidden boolean

ユーザーに対して契約が非表示の場合は True
Group ID
 groupId string

グループを表す一意の識別子
件名
 name string

Web フォームの名前
ステータス
 status string

Web フォームの状態
Url
 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 string

ワークフロー作成時に入力された説明
作成日
 created string

ワークフローが作成された日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ
変更日
 modified string

ワークフローが変更された日付。 形式は yyyy-MM-dd'T'HH:mm:ssZ
件名
 name string

ワークフローの名前
Display Name
 displayName string

ワークフローの表示名
Status
 status string

ワークフローの状態
範囲
 scope string

ワークフローのスコープ
作成者 ID
 originatorId string

ワークフローの初期作成者
スコープ ID
 scopeId string

スコープの識別子。 現在、これはスコープ GROUP にのみ適用され、値は groupId になります。

userWorkflowListV6

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

名前 パス 型 説明
ワークフロー リスト
 userWorkflowList array of UserWorkflowV6

ワークフロー項目の配列

WorkflowDefaultParamsV6

ワークフローの既定のパラメーター オブジェクトを含む JSON

名前 パス 型 説明
Default Value
 defaultValue string

このフィールドへの入力がなく、かつ必須フィールドである場合は、フィールドの既定値
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
Required
 required boolean

このフィールドが必須か省略可能かを示します
表示可能
 visible boolean

現在のフィールドが表示されるかどうか。 このフィールドの可視属性がfalseの場合、このフィールドは、このワークフローを使用する契約書作成UIでユーザーに表示されません

CCsListInfoDescriptionV6

ワークフローに関する詳細情報を含む JSON

名前 パス 型 説明
既定値
 defaultValues array of string

このリスト要素に何も入力がない場合に使用される既定の電子メールの配列
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
Label
 label string

現在の CC リストに使用できるワークフロー ユーザーの表示テキスト
最大 CC エントリ数
 maxListCount integer

現在の CC リストで許可されているエントリの最大数
最小 CC エントリ数
 minListCount integer

現在の CC リストで許可されているエントリの最小数
CC リスト名
 name string

現在の CC リストの名前
Required
 required boolean

このフィールドが必須か省略可能かを示します
表示可能
 visible boolean

現在のフィールドが表示されるかどうか。 このフィールドの可視属性がfalseの場合、このフィールドは、このワークフローを使用する契約書作成ページでユーザーに表示されません

ExpirationFieldInfoDescriptionV6

有効期限に関する情報を含む JSON

名前 パス 型 説明
Default Value
 defaultValue string

このフィールドへの入力がなく、かつ必須フィールドである場合は、フィールドの既定値
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
契約有効期間最大日数
 maxDays integer

契約有効期間の日数の最大値
Required
 required boolean

このフィールドが必須か省略可能かを示します
表示可能
 visible boolean

現在のフィールドが表示されるかどうか。 このフィールドの可視属性がfalseの場合、このフィールドは、このワークフローを使用する契約書作成ページでユーザーに表示されません

FileInfosDescriptionV6

ファイルに関する情報を含む JSON

名前 パス 型 説明
Label
 label string

この外部ユーザー フィールドの表示ラベル
件名
 name string

fileInfo 要素の名前
Required
 required boolean

このフィールドが必須か省略可能かを示します
ワークフロー ライブラリ ドキュメント
 workflowLibraryDocumentSelectorList array of WorkflowLibraryDocumentV6

ワークフロー ライブラリ ドキュメントの一覧。この fileInfo オブジェクトを指定して、この一覧からワークフロー ライブラリ ドキュメントを 1 つ選択できます

WorkflowLibraryDocumentV6

ワークフロー ライブラリ ドキュメントに関する情報を含む JSON

名前 パス 型 説明
Label
 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

このワークフローで選択可能なロケール
Default Value
 defaultValue string

このフィールドへの入力がなく、かつ必須フィールドである場合は、フィールドの既定値
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
Required
 required boolean

このフィールドが必須か省略可能かを示します
表示可能
 visible boolean

現在のフィールドが表示されるかどうか。 このフィールドの可視属性がfalseの場合、このフィールドは、このワークフローを使用する契約書作成UIでユーザーに表示されません

MergeFieldInfoDescriptionV6

マージ フィールドに関する詳細情報を含む JSON

名前 パス 型 説明
Default Value
 defaultValue string

このフィールドへの入力がなく、かつ必須フィールドである場合は、フィールドの既定値
Display Name
 displayName string

このカスタム フィールドに表示可能な表示テキスト
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
カスタム フィールド名
 fieldName string

このワークフローのカスタム フィールドの名前
Required
 required boolean

このフィールドが必須か省略可能かを示します
表示可能
 visible boolean

現在のフィールドを契約書作成ページに表示するかどうか。 このフィールドの可視属性がfalseの場合、このフィールドは、このワークフローを使用する契約書作成ページでユーザーに表示されません

PasswordFieldInfoDescriptionV6

パスワードに関する詳細情報を含む JSON

名前 パス 型 説明
Password
 defaultValue string

パスワード情報フィールドの既定値
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
Label
 label string

パスワード フィールドのラベル
件名
 name string

パスワード フィールドの名前
Required
 required boolean

このフィールドが必須か省略可能かを示します
表示可能
 visible boolean

契約作成ページにパスワード情報フィールドを表示するかどうかを示します

RecipientsListInfoDescriptionV6

受信者リストに関する詳細情報を含む JSON

名前 パス 型 説明
送信者を許可
 allowSender boolean

送信者を受信者として許可するかどうかを示します
送信者を許可
 allowfax boolean

FAX を許可するかどうかを示します
認証方法
 authenticationMethod string

現在の受信者リストでドキュメントの表示や署名を許可するための認証方法、
既定の電子メール/FAX の値
 defaultValue string

既定の電子メールまたは FAX 番号
編集可能
 editable boolean

現在のフィールドが編集可能かどうか。 このフィールドの編集可能な属性が false の場合、このフィールドは契約書作成リクエストに指定しないでください。このフィールドのデフォルト値は契約書作成時に使用されます
Label
 label string

現在の受信者の一覧に使用できるワークフロー ユーザーの表示テキスト
最大受信者
 maxListCount integer

現在の受信者リストで許可されているエントリの最大数
最小受信者
 minListCount integer

現在の受信者リストで許可されているエントリの最小数
受信者情報リストの名前
 name string

現在の受信者情報リストの名前
参加者ロール
 role string

参加者の現在のロール
表示可能
 visible boolean

現在のフィールドが表示されるかどうか。 このフィールドの可視属性がfalseの場合、このフィールドは、このワークフローを使用する契約書作成UIでユーザーに表示されません

WorkflowDescriptionV6

ワークフローに関する詳細情報を含む JSON

名前 パス 型 説明
agreementNameInfo
 agreementNameInfo WorkflowDefaultParamsV6

ワークフローの既定のパラメーター オブジェクトを含む JSON
authoringInfo
 authoringInfo WorkflowDefaultParamsV6

ワークフローの既定のパラメーター オブジェクトを含む 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

ワークフローの既定のパラメーター オブジェクトを含む JSON
変更日
 modified string

ワークフローが最後に修正された日
ワークフロー名
 name string

ワークフローの名前
passwordInfo
 passwordInfo PasswordFieldInfoDescriptionV6

パスワードに関する詳細情報を含む JSON
受信者リスト情報
 recipientsListInfo array of RecipientsListInfoDescriptionV6

契約作成要求に入力する受信者情報フィールドに関する情報
ワークフロー スコープ
 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

名前 パス 型 説明
Group ID
 id string

グループを表す一意の識別子
グループ管理者かどうか
 isGroupAdmin boolean

ユーザーがグループ管理者の場合は True
プライマリ グループかどうか
 isPrimaryGroup boolean

グループがユーザーのプライマリ グループの場合は True
Status
 status string

グループ メンバーシップの状態
作成日
 createdDate date

グループが作成された日付
グループ名
 name string

グループの名前
設定
 settings SettingsInfoV6

UserGroupsInfoV6

指定されたユーザーのグループのリストを含む JSON

名前 パス 型 説明
ユーザー グループ リスト
 groupInfoList array of UserGroupInfoV6

ユーザー グループ情報項目の配列

binary

これは基本的なデータ型 'バイナリ' です。

オブジェクト

’オブジェクト’ という種類です。

file

これは基本的なデータ型 'ファイル' です。