RSign (プレビュー)
RSign® は、ドキュメント ワークフローを合理化する、安全で法的にバインドされた電子署名プラットフォームです。 このコネクタを使用すると、ユーザーは署名要求の送信を自動化し、リアルタイムのエンベロープ状態を追跡し、完成した署名済みドキュメントと署名証明書を取得できます。 ドキュメントの実行をデジタル化し、安全で追跡可能なデジタル トランザクションを確保することで、ビジネス効率を向上させます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate（パワーオートメート） | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | RSign のサポート |
| URL | https://rsign.com/contact/questions |
| support@rpost.com |
| コネクタ メタデータ | |
|---|---|
| 発行元 | RPost US Inc |
| 発行元 | RPost US Inc |
| Web サイト | https://rpost.com/ |
| プライバシー ポリシー | https://rpost.com/legal-notices/privacy-notice |
| カテゴリ | コンテンツとファイル。生産性 |
RSign カスタム コネクタの概要
コネクタ名: RSign の説明: RSign® は、セキュリティで保護され、法的にバインドされ、合理化されたドキュメント ワークフローのための電子署名およびデジタル トランザクション管理プラットフォームです。 パブリッシャー： RPost
1. コネクタ機能
RSign® コネクタを使用すると、電子署名とドキュメント管理機能にアクセスできるため、ユーザーは RSign ワークフローを Power Platform ソリューション (Power Automate、Power Apps、Logic Apps) に直接統合できます。
主要なアクション
コネクタは現在、次の主要な操作をサポートしています。
-
AuthToken を取得します。 RSign® 資格情報に基づいてユーザーを認証し、後続のすべての API 呼び出しに必要なトークン (
AuthToken) を取得します。 - テンプレートを使用して封筒を送信する: 事前構成済みの RSign® テンプレートを使用して電子署名用のドキュメントを送信し、テンプレート ロールを特定の受信者にマッピングします。
- ルールを使用してエンベロープを送信する: 事前に構成された RSign® ルールを使用して電子署名用のドキュメントを送信し、要求本文で Base64 データとしてドキュメントを指定できるようにします。
-
テンプレート情報の取得: 定義されたドキュメントや受信者ロール (
RoleID) など、特定の RSign® テンプレートまたはルールに関する詳細を取得します。 - 封筒の状態を取得する: エンベロープ コードを使用して電子署名要求の状態を取得します。
- 封筒ドキュメントを取得する: 封筒コードに関連付けられているドキュメント (元の署名済みドキュメントまたは最終的な署名済みドキュメント) をダウンロードします。
2. 認証のセットアップ
RSign® コネクタは、他のアクションを実行する前に、 Get AuthToken アクションを正常に呼び出す必要があるカスタム認証スキームを使用します。
認証アクション (Get AuthToken)
このアクションには、RSign® プラットフォームから取得する必要がある次の資格情報が必要です。
| パラメーター名 | タイプ | Description | 視認性 |
|---|---|---|---|
ReferenceKey |
文字列 | RPost® アカウントに関連付けられている参照キー。 | Important |
EmailId |
文字列 | RSign® アカウントの電子メール アドレス。 | Important |
Password |
パスワード | RSign® アカウントのパスワード。 | Important |
AuthToken の使用
Get AuthToken アクションは、応答本文でAuthTokenを返します。 その後、このトークンは、後続の API 呼び出しで、サポートされているすべてのアクションに渡す必要があります。
メモ：AuthTokenには有効期限 (AuthTokenExpires) があり、既存のトークンの有効期限が切れたときに新しいトークンが使用されるように、フローまたはアプリケーション ロジック内で管理する必要があります。
3. 前提条件
この RSign® カスタム コネクタを正常に使用するには、ユーザーが次の要件を満たしている必要があります。
- 有効な RSign® ライセンス: ユーザーには、アクティブで有効な RSign® ユーザー ライセンスが必要です。
-
API Access: 指定された資格情報に関連付けられている RSign® アカウントでは、 API アクセス機能が有効になっており、有料である必要があります。 この機能は、
ReferenceKeyを生成し、RSign® コネクタを正常に利用するために必要です。
現在これらの要件を満たしていない場合、または現在の RSign® アカウントのセットアップがわからない場合は、RPost® の担当者にお問い合わせください。
4. 統合に関する重要な注意事項
テンプレートとルールの使用法
-
テンプレート コード/ルール コード: どちらの
Send Envelopeアクションでも、RSign で事前に構成されたドキュメントと署名フィールドを識別するTemplateCode(またはルール コード) が必要です®。 -
ロール マッピング: エンベロープを送信するときは、
TemplateRoleRecipientMapping配列を設定する必要があります。 各受信者のRoleIDは、最初にRetrieve Template Informationアクションを使用して取得する必要があります。 これにより、受信者がテンプレートで定義されている署名フィールドに正しくマップされます。
ドキュメント処理
-
ルールを使用してエンベロープを送信する: このアクションでは、ドキュメントコンテンツを Base64 でエンコードされた文字列 (
DocumentBase64Data) として渡す必要があります。 -
封筒ドキュメントを取得する: ドキュメントは、応答本文内で Base64 文字列 (
ByteArray) として返されます。 使用するフローでは、この文字列をデコードしてファイルを保存する必要があります。
エラー処理
すべてのアクションは、次のような状態情報を応答本文で返します。
-
StatusCode(整数) -
StatusMessage(文字列) -
Message(文字列)
ユーザーは、操作が正常に実行されるように、 StatusCode に基づいてエラー チェックを実装する必要があります。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
|
Auth |
他のすべての RSign でサポートされているアクションで使用される AuthToken を返します。 |
| テンプレートを使用して封筒を送信する |
指定された RSign テンプレートを使用して、選択した受信者に eSign 要求を送信します。 |
| テンプレート情報の取得 |
コードに基づいてテンプレートまたはルールに関する情報を取得します。 返される情報の中には、定義されているテンプレート名、ドキュメント、ロールがあります。 |
| ルールを使用してエンベロープを送信する |
指定された RSign ルールを使用して、選択した受信者に eSign 要求を送信します。 |
| 封筒の状態を取得する |
封筒コードに基づいて封筒の状態を取得します。 詳細なレポートまたは集計レポートを選択できます。 |
| 封筒ドキュメントを取得する |
封筒コードに基づいて封筒の一部のドキュメントを取得します。 封筒の状態に応じて、元のドキュメントや最終的な署名済みドキュメントが取得されます。 |
AuthToken を取得する
他のすべての RSign でサポートされているアクションで使用される AuthToken を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ReferenceKey
|
ReferenceKey | True | string |
会社アカウントの一意識別子。 |
|
EmailId
|
EmailId | True | string |
RSign アカウントの電子メール アドレス。 |
|
パスワード
|
Password | True | password |
RSign アカウントのパスワード。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
認証メッセージ
|
AuthMessage | string |
応答の状態メッセージ。 |
|
認証トークン
|
AuthToken | string |
他の RSign アクションで使用される認証トークン。 |
|
更新トークン
|
RefreshToken | string |
更新トークン。 |
|
更新トークンの有効期限
|
RefreshTokenExpires | string |
現在の更新トークンの有効期限が切れる日付。 |
|
認証トークンの有効期限
|
AuthTokenExpires | string |
現在の認証トークンの有効期限が切れる日付。 |
|
電子メール ID
|
EmailId | string |
認証されたユーザーの電子メール。 |
|
API Id
|
ApiId | string |
API ID。 |
テンプレートを使用して封筒を送信する
指定された RSign テンプレートを使用して、選択した受信者に eSign 要求を送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
認証トークン
|
AuthToken | True | string |
"Get AuthToken" アクションから取得された AuthToken。 |
|
TemplateCode
|
TemplateCode | True | string |
使用するテンプレートの ID。 |
|
アプリ キー
|
AppKey | string |
コネクタを使用するシステムの一意識別子。 RPost® サポートにお問い合わせください。 |
|
|
RoleID
|
RoleID | True | string |
受信者のロール ID。 [テンプレート情報の取得] アクションから取得されます。 |
|
RecipientEmail
|
RecipientEmail | True | string |
受信者のメール アドレス。 |
|
RecipientName
|
RecipientName | True | string |
受信者の名前。 |
|
モバイル
|
Mobile | string |
受信者の携帯電話番号。 テンプレートに必要がない場合は、空白のままにします。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒コード
|
EnvelopeCode | string |
封筒の ID。 |
|
透過性の変更されたメッセージ
|
TransparencyChangedMessage | string |
透過性が変更されたメッセージ。 |
|
言語ベースの API メッセージ
|
LanguageBasedApiMessge | string |
言語ベースの API メッセージ。 |
|
受信者 ID を事前入力する
|
PrefillRecipientId | string |
受信者 ID を事前入力します。 |
|
送信後のナビゲーション ページ
|
PostSendingNavigationPage | string |
受信者が封筒への署名を完了するとリダイレクトされる Web サイト。 |
|
新しい署名者 UI が有効になっているか
|
IsNewSignerUIEnabled | boolean |
新しい署名者 UI が有効になっています。 |
|
状態コード
|
StatusCode | integer |
応答状態コード。 |
|
ステータス メッセージ
|
StatusMessage | string |
応答の状態メッセージ。 |
|
メッセージ
|
Message | string |
応答の状態の説明。 |
|
封筒 ID
|
EnvelopeId | string |
生成されたエンベロープの内部 ID。 |
|
ドキュメント URL に署名する
|
SignDoumentUrl | string |
エンベロープの署名のグローバル URL。 |
|
受信者リスト
|
RecipientList | array of object |
受信者の詳細 |
|
受信者名
|
RecipientList.RecipientName | string |
現在の封筒の受信者部分の名前。 |
|
受信者の電子メール
|
RecipientList.RecipientEmail | string |
現在の封筒の受信者部分の電子メール アドレス。 |
|
注文
|
RecipientList.Order | integer |
受信者が封筒を完成させるためにアクセスする必要がある順序。 |
|
タイプ
|
RecipientList.Type | string |
現在の封筒の受信者部分の種類。 使用可能な値は、署名者と事前入力です。 |
|
配信モード
|
RecipientList.DeliveryMode | integer |
署名要求とアクセス コードが受信者に送信されたチャネルを示します。 |
|
ダイヤル コード
|
RecipientList.DialCode | string |
署名要求とアクセス コードが送信された国のダイヤル コード。 |
|
国番号
|
RecipientList.CountryCode | string |
署名要求とアクセス コードが送信された国のコード。 |
|
携帯電話番号
|
RecipientList.Mobile | string |
受信者の携帯電話番号。 |
|
モバイル モード
|
RecipientList.MobileMode | integer |
署名要求とアクセス コードが受信者に送信されたモバイル チャネルを示します。 |
|
署名 URL
|
RecipientList.SigningUrl | string |
受信者がエンベロープにアクセスして署名するために使用する URL。 |
|
ダイヤル コードのドロップダウン リスト
|
DialCodeDropdownList | string |
ダイヤル コードのドロップダウン リスト。 |
|
モバイルへのメッセージを有効にする
|
EnableMessageToMobile | string |
モバイルへのメッセージを有効にします。 |
テンプレート情報の取得
コードに基づいてテンプレートまたはルールに関する情報を取得します。 返される情報の中には、定義されているテンプレート名、ドキュメント、ロールがあります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テンプレート コード
|
TemplateCode | True | string |
取得するテンプレートのコード。 |
|
認証トークン
|
AuthToken | True | string |
"Get AuthToken" アクションから取得された AuthToken。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態コード
|
StatusCode | integer |
応答状態コード。 |
|
ステータス メッセージ
|
StatusMessage | string |
応答の状態メッセージ。 |
|
メッセージ
|
Message | string |
応答の状態の説明。 |
|
テンプレート ID
|
TemplateId | string |
テンプレート ID。 |
|
テンプレート ID
|
TemplateBasicInfo.TemplateId | string |
テンプレート ID。 |
|
テンプレート コード
|
TemplateBasicInfo.TemplateCode | integer |
他のアクションで使用するテンプレート コード。 |
|
ユーザー Email
|
TemplateBasicInfo.UserEmail | string |
テンプレートのユーザー所有者の電子メール。 |
|
テンプレート名
|
TemplateBasicInfo.TemplateName | string |
テンプレートの名前。 |
|
テンプレートの説明
|
TemplateBasicInfo.TemplateDescription | string |
テンプレートの説明。 |
|
静的
|
TemplateBasicInfo.IsStatic | string |
テンプレートを変更できるかどうかを示します。 |
|
有効期限
|
TemplateBasicInfo.ExpiryDate | string |
テンプレートの有効期限が切れる日付。 |
|
作成日
|
TemplateBasicInfo.CreatedDate | string |
テンプレートが作成された日付。 |
|
最終変更日
|
TemplateBasicInfo.LastModifiedDate | string |
テンプレートが最後に変更された日付。 |
|
サブジェクト
|
TemplateBasicInfo.Subject | string |
電子メール テンプレートの件名。 |
|
Body
|
TemplateBasicInfo.Body | string |
電子メール テンプレートの本文。 HTML エンコード。 |
|
型名
|
TemplateBasicInfo.TypeName | string |
テンプレートの種類 (使用可能な値: テンプレート、ルール)。 |
|
ドキュメント リスト
|
TemplateBasicInfo.DocumentList | array of object |
ドキュメントの一覧。 |
|
ドキュメント ID
|
TemplateBasicInfo.DocumentList.DocumentId | string |
テンプレートのドキュメント部分の ID。 |
|
ドキュメント名
|
TemplateBasicInfo.DocumentList.DocumentName | string |
テンプレートのドキュメント部分の名前。 |
|
注文
|
TemplateBasicInfo.DocumentList.Order | integer |
テンプレートのドキュメント 一覧内のドキュメントパーツの順序。 |
|
ドキュメント コンテンツの詳細
|
TemplateBasicInfo.DocumentList.documentContentDetails | array of object |
ドキュメント コンテンツの詳細。 |
|
コントロール ID
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlID | string |
ドキュメントで使用されるコントロールの内部 ID。 |
|
コントロール名
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlName | string |
ドキュメントで使用されるコントロールの名前。 |
|
Html ID を制御する
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID | string |
ドキュメントで使用されるコントロールの HTML ID。 |
|
グループ名
|
TemplateBasicInfo.DocumentList.documentContentDetails.GroupName | string |
コントロールを含むグループの名前。 |
|
ラベル
|
TemplateBasicInfo.DocumentList.documentContentDetails.Label | string |
ドキュメントに表示するコントロールの名前。 |
|
ページいいえ
|
TemplateBasicInfo.DocumentList.documentContentDetails.PageNo | integer |
コントロールが配置されているドキュメント内のページ。 |
|
必須
|
TemplateBasicInfo.DocumentList.documentContentDetails.Required | boolean |
コントロールが必要かどうか。 |
|
コントロール値
|
TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue | string |
コントロールの事前入力された値。 |
|
ロール ID
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleId | string |
コントロールに入力する必要があるロールの ID。 |
|
役割名
|
TemplateBasicInfo.DocumentList.documentContentDetails.RoleName | string |
コントロールに入力する必要があるロールの名前。 |
|
コントロール オプションの選択
|
TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions | array of string |
[コントロール オプション] を選択します。 |
|
テンプレート ロールの一覧
|
TemplateBasicInfo.TemplateRoleList | array of object |
受信者の一覧。 |
|
ロール ID
|
TemplateBasicInfo.TemplateRoleList.RoleID | string |
このテンプレートのロール 部分の ID。 |
|
役割名
|
TemplateBasicInfo.TemplateRoleList.RoleName | string |
このテンプレートのロール 部分の名前。 |
|
注文
|
TemplateBasicInfo.TemplateRoleList.Order | integer |
ロール (受信者) がテンプレートを完了する必要がある順序。 |
|
受信者の電子メール
|
TemplateBasicInfo.TemplateRoleList.RecipientEmail | string |
このテンプレートの受信者部分の事前入力済みメール。 |
|
受信者名
|
TemplateBasicInfo.TemplateRoleList.RecipientName | string |
このテンプレートの受信者部分の事前入力された名前。 |
|
受信者の種類 ID
|
TemplateBasicInfo.TemplateRoleList.RecipientTypeID | string |
受信者の種類の内部 ID。 |
|
受信者 ID
|
TemplateBasicInfo.TemplateRoleList.RecipientID | string |
このテンプレートの受信者部分の ID。 |
|
受信者の種類
|
TemplateBasicInfo.TemplateRoleList.RecipientType | string |
受信者の種類。 |
|
Cc 署名者の種類
|
TemplateBasicInfo.TemplateRoleList.CcSignerType | string |
CC 受信者の種類。 |
|
カルチャ情報
|
TemplateBasicInfo.TemplateRoleList.CultureInfo | string |
これは、テンプレート/ルールを作成した時点でのユーザーのサービス言語です。 |
|
配信モード
|
TemplateBasicInfo.TemplateRoleList.DeliveryMode | integer |
署名要求とアクセス コードが受信者に送信されたチャネルを示します。 |
|
ダイヤル コード
|
TemplateBasicInfo.TemplateRoleList.DialCode | string |
署名要求とアクセス コードが送信された国のダイヤル コード。 |
|
国番号
|
TemplateBasicInfo.TemplateRoleList.CountryCode | string |
署名要求とアクセス コードが送信された国のコード。 |
|
携帯電話番号
|
TemplateBasicInfo.TemplateRoleList.Mobile | string |
受信者の携帯電話番号。 |
|
モバイル モード
|
TemplateBasicInfo.TemplateRoleList.MobileMode | integer |
署名要求とアクセス コードが受信者に送信されたモバイル チャネルを示します。 |
|
メール アドレス
|
TemplateBasicInfo.TemplateRoleList.EmailAddress | string |
受信者の電子メール アドレス。 |
|
モバイルへのメッセージを有効にする
|
TemplateBasicInfo.EnableMessageToMobile | boolean |
モバイルへのメッセージを有効にします。 |
|
静的リンクの有効期限
|
TemplateBasicInfo.StaticLinkExpiryDate | string |
静的リンクの有効期限日。 |
|
テンプレート リスト
|
TemplateList | string |
テンプレート リスト。 |
ルールを使用してエンベロープを送信する
指定された RSign ルールを使用して、選択した受信者に eSign 要求を送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
認証トークン
|
AuthToken | True | string |
"Get AuthToken" アクションから取得された AuthToken。 |
|
TemplateCode
|
TemplateCode | True | string |
使用するルールの ID。 |
|
名前
|
Name | True | string |
ドキュメント名。 拡張機能を含めます (例: Agreement.docx)。 |
|
DocumentBase64Data
|
DocumentBase64Data | True | string |
Base64 形式で送信されるドキュメント。 |
|
アプリ キー
|
AppKey | string |
コネクタを使用するシステムの一意識別子。 RPost® サポートにお問い合わせください。 |
|
|
RoleID
|
RoleID | True | string |
受信者のロール ID。 [テンプレート情報の取得] アクションから取得されます。 |
|
RecipientEmail
|
RecipientEmail | True | string |
受信者のメール アドレス。 |
|
RecipientName
|
RecipientName | True | string |
受信者の名前。 |
|
モバイル
|
Mobile | string |
受信者の携帯電話番号。 ルールに必要がない場合は、空白のままにします。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
封筒コード
|
EnvelopeCode | string |
封筒の ID。 |
|
透過性の変更されたメッセージ
|
TransparencyChangedMessage | string |
透過性が変更されたメッセージ。 |
|
言語ベースの API メッセージ
|
LanguageBasedApiMessge | string |
言語ベースの API メッセージ。 |
|
受信者 ID を事前入力する
|
PrefillRecipientId | string |
受信者 ID を事前入力します。 |
|
送信後のナビゲーション ページ
|
PostSendingNavigationPage | string |
受信者が封筒への署名を完了するとリダイレクトされる Web サイト。 |
|
新しい署名者 UI が有効になっているか
|
IsNewSignerUIEnabled | boolean |
新しい署名者 UI が有効になっています。 |
|
状態コード
|
StatusCode | integer |
応答状態コード。 |
|
ステータス メッセージ
|
StatusMessage | string |
応答の状態メッセージ。 |
|
メッセージ
|
Message | string |
応答の状態の説明。 |
|
封筒 ID
|
EnvelopeId | string |
生成されたエンベロープの内部 ID。 |
|
ドキュメント URL に署名する
|
SignDoumentUrl | string |
エンベロープの署名のグローバル URL。 |
|
受信者リスト
|
RecipientList | array of object |
受信者の詳細 |
|
受信者名
|
RecipientList.RecipientName | string |
受信者の名前。 |
|
受信者の電子メール
|
RecipientList.RecipientEmail | string |
受信者のメール アドレス。 |
|
注文
|
RecipientList.Order | integer |
受信者が封筒を完成させるためにアクセスする必要がある順序。 |
|
タイプ
|
RecipientList.Type | string |
現在の封筒の受信者部分の種類。 使用可能な値は、署名者と事前入力です。 |
|
配信モード
|
RecipientList.DeliveryMode | integer |
署名要求とアクセス コードが受信者に送信されたチャネルを示します。 |
|
ダイヤル コード
|
RecipientList.DialCode | string |
署名要求とアクセス コードが送信された国のダイヤル コード。 |
|
国番号
|
RecipientList.CountryCode | string |
署名要求とアクセス コードが送信された国のコード。 |
|
携帯電話番号
|
RecipientList.Mobile | string |
受信者の携帯電話番号。 |
|
モバイル モード
|
RecipientList.MobileMode | integer |
署名要求とアクセス コードが受信者に送信されたモバイル チャネルを示します。 |
|
署名 URL
|
RecipientList.SigningUrl | string |
受信者がエンベロープにアクセスして署名するために使用する URL。 |
|
ダイヤル コードのドロップダウン リスト
|
DialCodeDropdownList | string |
ダイヤル コードのドロップダウン リスト。 |
|
モバイルへのメッセージを有効にする
|
EnableMessageToMobile | string |
モバイルへのメッセージを有効にします。 |
封筒の状態を取得する
封筒コードに基づいて封筒の状態を取得します。 詳細なレポートまたは集計レポートを選択できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
認証トークン
|
AuthToken | True | string |
"Get AuthToken" アクションから取得された AuthToken。 |
|
EnvelopeCode
|
EnvelopeCode | True | string |
封筒コード。 |
|
DetailOrSummary
|
DetailOrSummary | True | string |
目的のレポートの種類を選択します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ステータス
|
Status | boolean |
要求の状態。 |
|
状態コード
|
StatusCode | integer |
応答状態コード。 |
|
メッセージ
|
Message | string |
応答の状態の説明。 |
|
ステータス メッセージ
|
StatusMessage | string |
応答の状態メッセージ。 |
|
封筒データ一覧
|
Data | array of object | |
|
封筒コード
|
Data.EnvelopeCode | string |
封筒の ID。 |
|
封筒 ID
|
Data.EnvelopeID | string |
封筒の内部 ID。 |
|
サブジェクト
|
Data.Subject | string |
封筒の電子メールの件名。 |
|
封筒の状態
|
Data.Status | string |
要求された封筒の状態。 |
|
IsEnvelopeComplete
|
Data.IsEnvelopeComplete | boolean |
封筒が完成したかどうかを示します。 |
|
送信日
|
Data.SentDate | string |
封筒が送信された日付。 |
|
最終更新日
|
Data.LastModifiedDate | string |
最終更新日。 |
|
SenderName
|
Data.SenderName | string |
送信者の名前。 |
|
SenderEmail
|
Data.SenderEmail | string |
送信者の電子メール。 |
|
受信者の詳細
|
Data.RecipientDetails | array of object | |
|
受信者 ID
|
Data.RecipientDetails.RecipientID | string |
現在の封筒の受信者部分の ID。 |
|
受信者の種類 ID
|
Data.RecipientDetails.RecipientTypeID | string |
現在の封筒の受信者部分の ID を入力します。 |
|
受信者の種類
|
Data.RecipientDetails.RecipientType | string |
現在の封筒の受信者部分の種類。 使用可能な値は、署名者と事前入力です。 |
|
受信者名
|
Data.RecipientDetails.RecipientName | string |
受信者の名前。 |
|
Email
|
Data.RecipientDetails.Email | string |
受信者のメール アドレス。 |
|
注文
|
Data.RecipientDetails.Order | integer |
受信者が封筒を完成させるためにアクセスする必要がある順序。 |
|
StatusID
|
Data.RecipientDetails.StatusId | string |
状態 ID。 |
|
署名の状態
|
Data.RecipientDetails.SigningStatus | string |
封筒の受信者の署名の状態。 |
|
最終変更日
|
Data.RecipientDetails.LastModifiedDate | string |
最終更新日。 |
|
参照コード
|
Data.ReferenceCode | string |
現在の封筒の参照コード部分。 |
|
参照メール
|
Data.ReferenceEmail | string |
現在の封筒の電子メール部分を参照します。 |
|
TotalCount
|
TotalCount | integer |
要求された条件に一致する封筒の合計量。 |
|
IsAttachmentUploadsExist
|
IsAttachmentUploadsExist | string |
添付ファイルのアップロードが存在します。 |
封筒ドキュメントを取得する
封筒コードに基づいて封筒の一部のドキュメントを取得します。 封筒の状態に応じて、元のドキュメントや最終的な署名済みドキュメントが取得されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒コード
|
EnvelopeCode | True | string |
取得するエンベロープのコード。 |
|
認証トークン
|
AuthToken | True | string |
"Get AuthToken" アクションから取得された AuthToken。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ステータス
|
Status | boolean |
状態の成功フラグ。 |
|
状態コード
|
StatusCode | integer |
応答状態コード。 |
|
メッセージ
|
Message | string |
応答の状態の説明。 |
|
ステータス メッセージ
|
StatusMessage | string |
応答の状態メッセージ。 |
|
封筒コード
|
Data.EnvelopeCode | string |
パラメーターとして渡されるエンベロープ コード。 |
|
ドキュメント リスト
|
Data.DocumentList | array of object |
ドキュメントの一覧。 |
|
ドキュメントの種類
|
Data.DocumentList.DocumentType | string |
添付ファイルの種類。 |
|
ファイル名
|
Data.DocumentList.FileName | string |
ファイルの名前。 |
|
Description
|
Data.DocumentList.Description | string |
ドキュメントの説明。 |
|
バイト配列
|
Data.DocumentList.ByteArray | string |
Base64 形式のファイル。 |
|
追加情報
|
Data.DocumentList.AdditionalInfo | string |
追加情報。 |
|
添付ファイルの説明
|
Data.DocumentList.AttachmentDescription | string |
ファイルの内容に関する情報の説明。 |
|
読み取り
|
Data.ReadMe | string |
署名されたドキュメントの名前と元のファイルを示す Base64 形式のテキスト ファイル。 |
|
結合された Zip
|
Data.CombinedZip | string |
封筒のすべてのドキュメントを含む Zip ファイル。 |
|
総計
|
TotalCount | integer |
合計カウント。 |
|
添付ファイルのアップロードが存在するか
|
IsAttachmentUploadsExist | string |
添付ファイルのアップロードが存在します。 |