Certinal eSign (プレビュー)
Certinal eSign を使用すると、企業はグローバルに準拠した eSignature を使用してドキュメントを安全に送信、署名、管理できます。 規制対象の業界向けに設計されたCertinalは、リアルタイムのワークフロー追跡、改ざん防止監査証跡、シームレスな自動化を提供します。 ワークフローで Certinal eSign を使用して、承認をデジタル化し、プロセスを高速化し、70 以上の国で法的に有効な署名を確保します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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) |
| お問い合わせ | |
|---|---|
| 名前 | ヘルプとサポート |
| URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| コネクタ メタデータ | |
|---|---|
| パブリッシャー | Certinal Inc. |
| Web サイト | https://www.certinal.com/ |
| プライバシー ポリシー | https://www.certinal.com/privacy-policy |
| カテゴリ | 生産性;ビジネス管理 |
Certinal eSign
概要
Certinal eSign は、Power Automate からドキュメントを直接送信、署名、追跡、管理するグローバル 企業向けの、セキュリティで保護された準拠した eSignature ワークフローと eConsent ワークフローを提供します。
[前提条件]
コネクタ トリガーを使用するには、Certinal 管理者アカウントが必要です。 この統合でコネクタ トリガーを使用するには、Certinal 管理者設定で Power Connector を有効にする必要があります。
資格情報を取得する方法
Certinal は API キーを使用してサービスを認証します。 Certinal 管理者アカウントから API キーを生成する必要があります。
サポートされている操作
コネクタは、次の操作をサポートしています。
トランザクションの詳細を取得する
トランザクション ID でトランザクションの詳細を取得する
トランザクションのドキュメントをダウンロードする
指定されたトランザクション ID のドキュメントをダウンロードする
トランザクションの作成
トランザクションの作成
テンプレートを使用してトランザクションを作成する
指定されたテンプレート ID を使用してトランザクションを作成する
ユーザー一覧表示
ユーザー一覧表示
ユーザーの詳細を取得する
特定のユーザー ID のユーザーの詳細を取得する
[Create User]
[Create User]
サポートされているトリガー
コネクタでは、次のトリガーがサポートされています。
トランザクションの状態が変更されたとき
特定のトランザクション イベントのコールバックを登録する
API ドキュメント:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
ヘルプとサポート
https://esign.certinal.com/esign/certinal-docs/help-support
接続の作成
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API キー | securestring | この API の API キー | 正しい |
| ベース API エンドポイント | 文字列 | API エンドポイントのベース URL (例: api.certinal.com) | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| [Create User] |
[Create User] |
| サブスクリプションの削除 |
サブスクリプションの削除 |
| テンプレートを使用してトランザクションを作成する |
指定されたテンプレート ID を使用してトランザクションを作成する |
| トランザクションのドキュメントをダウンロードする |
指定されたトランザクション ID のドキュメントをダウンロードする |
| トランザクションの作成 |
トランザクションの作成 |
| トランザクションの詳細を取得する |
トランザクション ID でトランザクションの詳細を取得する |
| ユーザーの詳細を取得する |
特定のユーザー ID のユーザーの詳細を取得する |
| ユーザー一覧表示 |
ユーザー一覧表示 |
[Create User]
[Create User]
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール アドレス
|
emailAddress | string |
メール アドレス |
|
|
名前
|
firstName | string |
名前 |
|
|
姓
|
lastName | string |
姓 |
|
|
[会社]
|
company | string |
[会社] |
|
|
タイムゾーン
|
timezone | string |
タイムゾーン |
|
|
Language
|
language | string |
Language |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
役職
|
jobTitle | string |
役職 |
|
|
電話番号
|
phoneNumber | string |
電話番号 |
|
|
国番号
|
phoneCountryCode | string |
国番号 |
|
|
役割
|
roles | array of string |
役割 |
|
|
最終メールは無効になっていますか?
|
finalMailDisabled | boolean |
最終メールは無効になっていますか? |
|
|
アラーム メールは無効になっていますか?
|
reminderMailDisabled | boolean |
アラーム メールは無効になっていますか? |
|
|
送信者のメールは無効になっていますか?
|
senderMailDisabled | boolean |
送信者のメールは無効になっていますか? |
|
|
統合ユーザーですか?
|
integrationUser | boolean |
統合ユーザーですか? |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
ユーザー ID
|
data.user_id | string |
ユーザー ID |
サブスクリプションの削除
サブスクリプションの削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook Id
|
webhookId | True | string |
削除する Webhook サブスクリプションの一意識別子 |
テンプレートを使用してトランザクションを作成する
指定されたテンプレート ID を使用してトランザクションを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トランザクション名
|
name | string |
トランザクション名 |
|
|
トランザクションの状態
|
status | string |
トランザクションの状態 |
|
|
外部 ID
|
externalId | string |
外部 ID |
|
|
テンプレート ID
|
templateId | string |
テンプレート ID |
|
|
セカンダリ テンプレート ID
|
secondaryTemplateIds | array of string |
セカンダリ テンプレート ID |
|
|
メッセージ
|
message | string |
すべての参加者の電子メールのメッセージ。 |
|
|
コールバック URL
|
url | string |
コールバック URL |
|
|
トランザクション イベント
|
transactionEvents | array of string |
トランザクション イベント |
|
|
参加者イベント
|
participantEvents | array of string |
参加者イベント |
|
|
参加者のシーケンス
|
sequence | integer |
Sequence |
|
|
Role
|
role | string |
Role |
|
|
自動プロセスですか?
|
autoProcess | boolean |
自動プロセスですか? |
|
|
フィールド名
|
fieldName | string |
フィールド名 |
|
|
フィールド値
|
value | string |
フィールド値 |
|
|
名前
|
name | string |
候補者の名前 |
|
|
メール アドレス
|
emailAddress | string |
候補者のメール アドレス |
|
|
メッセージ
|
message | string |
メッセージ |
|
|
Language
|
language | string |
Language |
|
|
配信チャネル
|
deliveryChannels | array of string |
配信チャネル |
|
|
カスタム SMS 本文
|
customSMSBody | string |
カスタム SMS 本文 |
|
|
名前
|
name | string |
名前 |
|
|
メッセージ
|
message | string |
メッセージ |
|
|
必須ですか?
|
required | boolean |
必須ですか? |
|
|
名前
|
name | string |
名前 |
|
|
メール アドレス
|
emailAddress | string |
メール アドレス |
|
|
Language
|
language | string |
Language |
|
|
フィールド値
|
value | string |
フィールド値 |
|
|
フィールド名
|
fieldName | string |
フィールド名 |
|
|
Code
|
code | string |
Code |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
トランザクション ID
|
data.transactionId | string |
トランザクション ID |
トランザクションのドキュメントをダウンロードする
指定されたトランザクション ID のドキュメントをダウンロードする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トランザクション ID
|
transactionId | True | string |
一意のトランザクション ID |
|
ドキュメントの種類
|
documentType | True | string |
ダウンロードするドキュメントの種類 |
戻り値
- response
- file
トランザクションの作成
トランザクションの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トランザクション名
|
name | True | string |
トランザクション名 |
|
メッセージ
|
message | string |
すべての参加者の電子メールのメッセージ。 |
|
|
コールバック URL
|
url | string |
コールバック URL |
|
|
トランザクション イベント
|
transactionEvents | array of string |
トランザクション イベント |
|
|
参加者イベント
|
participantEvents | array of string |
参加者イベント |
|
|
トランザクションの状態
|
status | string |
トランザクションの状態 |
|
|
外部 ID
|
externalId | string |
外部 ID |
|
|
タイムスタンプで期限切れ
|
expiresAtTimestamp | string |
タイムスタンプでトランザクションの有効期限が切れる |
|
|
タイムスタンプからリマインドする
|
remindFromTimestamp | string |
タイムスタンプからリマインドする |
|
|
アラームの頻度
|
reminderFrequency | integer |
アラームの頻度 |
|
|
既定のフィールド
|
default | boolean |
既定の署名ブロック フィールド |
|
|
参加者のシーケンス
|
sequence | integer |
Sequence |
|
|
Role
|
role | string |
Role |
|
|
名前
|
name | string |
候補者の名前 |
|
|
メール アドレス
|
emailAddress | string |
候補者のメール アドレス |
|
|
Language
|
language | string |
Language |
|
|
認証モード
|
authenticationMode | string |
認証モード |
|
|
認証モードの値
|
authenticationModeValue | string |
認証モードの値 |
|
|
配信チャネル
|
deliveryChannels | array of string |
配信チャネル |
|
|
フィールド ID
|
fieldId | string |
フィールド ID |
|
|
ページ
|
pages | array of string |
ページ |
|
|
ドキュメント ID
|
documentId | string |
ドキュメント ID |
|
|
フィールドの幅
|
width | float |
フィールドの幅 |
|
|
フィールドの高さ
|
height | float |
フィールドの高さ |
|
|
Tooltip
|
tooltip | string |
Tooltip |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
テキスト領域の行数
|
textareaLineCount | string |
テキスト領域の行数 |
|
|
フィールド名
|
fieldName | string |
フィールド名 |
|
|
X 位置
|
xposition | float |
X フィールドの位置 |
|
|
Y 位置
|
yposition | float |
Y フィールドの位置 |
|
|
必須ですか?
|
required | boolean |
これは必須フィールドですか? |
|
|
読み取り専用ですか?
|
readOnly | boolean |
これは読み取り専用フィールドですか? |
|
|
テキスト領域
|
textarea | boolean |
テキスト領域 |
|
|
上の下
|
topBottom | boolean |
上の下 |
|
|
垂直
|
vertical | boolean |
垂直 |
|
|
無線グループ ID
|
radioGroupId | string |
無線グループ ID |
|
|
デフォルト値
|
defaultValue | string |
デフォルト値 |
|
|
価値
|
value | string |
価値 |
|
|
ラベルの表示
|
displayLabel | string |
ラベルの表示 |
|
|
名前
|
name | string |
名前 |
|
|
メール アドレス
|
emailAddress | string |
メール アドレス |
|
|
Language
|
language | string |
Language |
|
|
ドキュメント ID
|
id | string |
ドキュメント ID |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
削除可能ですか?
|
deletable | boolean |
削除可能ですか? |
|
|
プライベートである
|
private | boolean |
プライベートである |
|
|
フィールド値
|
value | string |
フィールド値 |
|
|
フィールド名
|
fieldName | string |
フィールド名 |
|
|
Code
|
code | string |
Code |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
トランザクション ID
|
data.transactionId | string |
トランザクション ID |
トランザクションの詳細を取得する
トランザクション ID でトランザクションの詳細を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トランザクション ID
|
transactionId | True | string |
一意のトランザクション ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
トランザクション名
|
data.name | string |
トランザクション名 |
|
トランザクションの状態
|
data.status | string |
トランザクションの状態 |
|
トランザクション ID
|
data.transactionId | string |
トランザクション ID |
|
メッセージ
|
data.mail.message | string |
すべての参加者の電子メールのメッセージ。 |
|
最終更新日
|
data.lastUpdatedDate | string |
最終更新日 |
|
作成日
|
data.createdDate | string |
作成日 |
|
ユーザー ID
|
data.createdBy.id | string |
ユーザー ID で作成 |
|
ユーザー名
|
data.createdBy.username | string |
ユーザー名で作成 |
|
メール アドレス
|
data.createdBy.emailAddress | string |
電子メール アドレスで作成 |
|
送信日
|
data.sentDate | string |
送信日 |
|
ユーザー ID
|
data.lastActionPerformedBy.userId | string |
ユーザー ID |
|
ユーザー名
|
data.lastActionPerformedBy.userName | string |
ユーザー名 |
|
メール アドレス
|
data.lastActionPerformedBy.emailAddress | string |
メール アドレス |
|
候補 ID
|
data.lastActionPerformedBy.candidateId | string |
候補 ID |
|
参加者 ID
|
data.lastActionPerformedBy.participantId | string |
参加者 ID |
|
タイムスタンプで期限切れ
|
data.expiryAndReminders.expiresAtTimestamp | string |
タイムスタンプでトランザクションの有効期限が切れる |
|
有効期限日
|
data.expiryAndReminders.expiryDays | integer |
有効期限日 |
|
リマインダーの日数を思い出させる
|
data.expiryAndReminders.remindFromReminderDays | integer |
リマインダーの日数を思い出させる |
|
リマインダーの時刻から通知する
|
data.expiryAndReminders.remindFromReminderTime | string |
リマインダーの時刻から通知する |
|
アラームの頻度
|
data.expiryAndReminders.reminderFrequency | integer |
アラームの頻度 |
|
参加者
|
data.participants | array of object |
参加者 |
|
参加者 ID
|
data.participants.id | string |
参加者 ID |
|
参加者の状態
|
data.participants.status | string |
参加者の状態 |
|
最終更新日
|
data.participants.lastUpdatedDate | string |
最終更新日 |
|
作成日
|
data.participants.createdDate | string |
作成日 |
|
参加者のシーケンス
|
data.participants.sequence | integer |
Sequence |
|
Role
|
data.participants.role | string |
Role |
|
署名方法
|
data.participants.signingMethodDTO | array of string |
署名方法の詳細 |
|
ユーザーによって送信
|
data.participants.submittedBys | array of object |
ユーザーの詳細によって送信 |
|
ユーザー ID
|
data.participants.submittedBys.userId | string |
ユーザー ID によって送信 |
|
ユーザー名
|
data.participants.submittedBys.userName | string |
ユーザーの名前で送信 |
|
メール アドレス
|
data.participants.submittedBys.emailAddress | string |
ユーザーの電子メール アドレスによって送信 |
|
候補 ID
|
data.participants.submittedBys.candidateId | string |
候補 ID |
|
候補 者
|
data.participants.candidates | array of object |
候補 者 |
|
候補 ID
|
data.participants.candidates.id | string |
候補 ID |
|
名前
|
data.participants.candidates.name | string |
候補者の名前 |
|
メール アドレス
|
data.participants.candidates.emailAddress | string |
候補者のメール アドレス |
|
Language
|
data.participants.candidates.language | string |
Language |
|
タイプ
|
data.participants.candidates.type | string |
タイプ |
|
アクション
|
data.participants.candidates.action | string |
アクション |
|
アクションの日付
|
data.participants.candidates.actionDate | string |
アクションの日付 |
|
作成日
|
data.participants.candidates.createdDate | string |
作成日 |
|
認証モードの値
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
認証モードの値 |
|
signing メソッドの詳細
|
data.participants.candidates.signingMethodDTO | array of string |
signing メソッドの詳細 |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
配信チャネル
|
data.participants.candidates.deliveryChannels | array of string |
配信チャネル |
|
田畑
|
data.participants.fields | array of object |
田畑 |
|
ID (アイディー)
|
data.participants.fields.id | string |
ID (アイディー) |
|
最終更新日
|
data.participants.fields.lastUpdatedDate | string |
最終更新日 |
|
作成日
|
data.participants.fields.createdDate | string |
作成日 |
|
フィールド ID
|
data.participants.fields.fieldId | string |
フィールド ID |
|
ページいいえ
|
data.participants.fields.pageNo | integer |
ページいいえ |
|
ドキュメント ID
|
data.participants.fields.documentId | string |
ドキュメント ID |
|
フィールドの幅
|
data.participants.fields.width | float |
フィールドの幅 |
|
フィールドの高さ
|
data.participants.fields.height | float |
フィールドの高さ |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
価値
|
data.participants.fields.value | string |
価値 |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
ラベルの表示
|
data.participants.fields.displayLabel | string |
ラベルの表示 |
|
リンクの種類
|
data.participants.fields.linkType | string |
リンクの種類 |
|
無線 ID
|
data.participants.fields.radioId | integer |
無線 ID |
|
無線グループ ID
|
data.participants.fields.radioGroupId | string |
無線グループ ID |
|
チェックボックス ID
|
data.participants.fields.checkboxId | integer |
チェックボックス ID |
|
フィールド名
|
data.participants.fields.fieldName | string |
フィールド名 |
|
X 位置
|
data.participants.fields.xposition | float |
X フィールドの位置 |
|
Y 位置
|
data.participants.fields.yposition | float |
Y フィールドの位置 |
|
必須ですか?
|
data.participants.fields.required | boolean |
これは必須フィールドですか? |
|
読み取り専用ですか?
|
data.participants.fields.readOnly | boolean |
これは読み取り専用フィールドですか? |
|
テキスト領域
|
data.participants.fields.textarea | boolean |
テキスト領域 |
|
垂直
|
data.participants.fields.vertical | boolean |
垂直 |
|
上の下
|
data.participants.fields.topBottom | boolean |
上の下 |
|
デフォルト値
|
data.participants.fields.defaultValue | string |
デフォルト値 |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
ID (アイディー)
|
data.participants.signatureBlock.format.id | string |
ID (アイディー) |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
必須ですか?
|
data.participants.signatureBlock.format.required | boolean |
必須ですか? |
|
既定値
|
data.participants.signatureBlock.default | boolean |
既定値 |
|
デリゲートを有効にする
|
data.participants.enableDelegate | boolean |
デリゲートを有効にする |
|
自動処理
|
data.participants.autoProcess | boolean |
自動処理 |
|
CC ユーザー
|
data.ccUsers | array of object |
CC ユーザー |
|
名前
|
data.ccUsers.name | string |
名前 |
|
メール アドレス
|
data.ccUsers.emailAddress | string |
メール アドレス |
|
Language
|
data.ccUsers.language | string |
Language |
|
ドキュメント
|
data.documents | array of object |
ドキュメント |
|
ドキュメント ID
|
data.documents.id | string |
ドキュメント ID |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
ファイル名
|
data.documents.fileName | string |
ファイル名 |
|
ページ数
|
data.documents.pageCount | integer |
ページ数 |
|
削除可能ですか?
|
data.documents.deletable | boolean |
削除可能ですか? |
|
プライベートである
|
data.documents.private | boolean |
プライベートである |
|
ユーザー設定フィールド
|
data.customFields | array of object |
ユーザー設定フィールド |
|
ユーザー設定フィールド ID
|
data.customFields.customFieldId | string |
ユーザー設定フィールド ID |
|
フィールド値
|
data.customFields.value | string |
フィールド値 |
|
フィールド名
|
data.customFields.fieldName | string |
フィールド名 |
|
フィールドの型
|
data.customFields.fieldType | string |
フィールドの型 |
|
通知サブスクリプション
|
data.notificationSubscriptions | array of |
通知サブスクリプション |
|
tags
|
data.tags | array of |
tags |
|
その他のドキュメント
|
data.additionalDocuments | array of object |
その他のドキュメント |
|
ID (アイディー)
|
data.additionalDocuments.id | string |
ID (アイディー) |
|
ファイル名
|
data.additionalDocuments.fileName | string |
ファイル名 |
|
タイプ
|
data.additionalDocuments.type | string |
タイプ |
|
候補 ID
|
data.additionalDocuments.candidateId | string |
候補 ID |
|
個別契約
|
data.separateAgreements | boolean |
個別契約 |
ユーザーの詳細を取得する
特定のユーザー ID のユーザーの詳細を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | True | string |
一意のユーザー ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
名前
|
data.firstName | string |
名前 |
|
姓
|
data.lastName | string |
姓 |
|
[会社]
|
data.company | string |
[会社] |
|
タイムゾーン
|
data.timezone | string |
タイムゾーン |
|
Language
|
data.language | string |
Language |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
役職
|
data.jobTitle | string |
役職 |
|
電話番号
|
data.phoneNumber | string |
電話番号 |
|
国番号
|
data.phoneCountryCode | string |
国番号 |
|
役割
|
data.roles | array of string |
役割 |
|
最終メールは無効になっていますか?
|
data.finalMailDisabled | boolean |
最終メールは無効になっていますか? |
|
アラーム メールは無効になっていますか?
|
data.reminderMailDisabled | boolean |
アラーム メールは無効になっていますか? |
|
送信者のメールは無効になっていますか?
|
data.senderMailDisabled | boolean |
送信者のメールは無効になっていますか? |
|
統合ユーザーですか?
|
data.integrationUser | boolean |
統合ユーザーですか? |
|
Salutation
|
data.salutation | string |
Salutation |
|
アクティブです
|
data.active | boolean |
アクティブです |
|
ID (アイディー)
|
data.id | string |
ID (アイディー) |
|
メール アドレス
|
data.emailAddress | string |
メール アドレス |
ユーザー一覧表示
ユーザー一覧表示
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ番号
|
pageNo | True | integer | |
|
各ページのレコード
|
perPageRecords | True | integer |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
合計レコード数
|
data.totalRecords | integer |
合計レコード数 |
|
合計ページ数
|
data.totalPages | integer |
合計ページ数 |
|
ページごとのレコード数
|
data.perPageRecords | integer |
ページごとのレコード数 |
|
ページ番号
|
data.pageNo | integer |
ページ番号 |
|
レコード
|
data.records | array of object |
ユーザー レコード |
|
名前
|
data.records.firstName | string |
名前 |
|
姓
|
data.records.lastName | string |
姓 |
|
[会社]
|
data.records.company | string |
[会社] |
|
タイムゾーン
|
data.records.timezone | string |
タイムゾーン |
|
Language
|
data.records.language | string |
Language |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
役職
|
data.records.jobTitle | string |
役職 |
|
電話番号
|
data.records.phoneNumber | string |
電話番号 |
|
国番号
|
data.records.phoneCountryCode | string |
国番号 |
|
役割
|
data.records.roles | array of string |
役割 |
|
最終メールは無効になっていますか?
|
data.records.finalMailDisabled | boolean |
最終メールは無効になっていますか? |
|
アラーム メールは無効になっていますか?
|
data.records.reminderMailDisabled | boolean |
アラーム メールは無効になっていますか? |
|
送信者のメールは無効になっていますか?
|
data.records.senderMailDisabled | boolean |
送信者のメールは無効になっていますか? |
|
統合ユーザーですか?
|
data.records.integrationUser | boolean |
統合ユーザーですか? |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
アクティブです
|
data.records.active | boolean |
アクティブです |
|
ID (アイディー)
|
data.records.id | string |
ID (アイディー) |
|
メール アドレス
|
data.records.emailAddress | string |
メール アドレス |
トリガー
| トランザクションの状態が変更されたとき |
特定のトランザクション イベントのコールバックを登録する |
トランザクションの状態が変更されたとき
特定のトランザクション イベントのコールバックを登録する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベントの種類
|
eventType | True | array |
登録するトランザクション イベントの種類 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイムスタンプ
|
timestamp | integer |
タイムスタンプ |
|
状態コード
|
statusCode | integer |
状態コード |
|
メッセージ
|
message | string |
メッセージ |
|
トランザクション名
|
data.name | string |
トランザクション名 |
|
トランザクションの状態
|
data.status | string |
トランザクションの状態 |
|
トランザクション ID
|
data.transactionId | string |
トランザクション ID |
|
メッセージ
|
data.mail.message | string |
すべての参加者の電子メールのメッセージ。 |
|
最終更新日
|
data.lastUpdatedDate | string |
最終更新日 |
|
作成日
|
data.createdDate | string |
作成日 |
|
ユーザー ID
|
data.createdBy.id | string |
ユーザー ID で作成 |
|
ユーザー名
|
data.createdBy.username | string |
ユーザー名で作成 |
|
メール アドレス
|
data.createdBy.emailAddress | string |
電子メール アドレスで作成 |
|
送信日
|
data.sentDate | string |
送信日 |
|
ユーザー ID
|
data.lastActionPerformedBy.userId | string |
ユーザー ID |
|
ユーザー名
|
data.lastActionPerformedBy.userName | string |
ユーザー名 |
|
メール アドレス
|
data.lastActionPerformedBy.emailAddress | string |
メール アドレス |
|
候補 ID
|
data.lastActionPerformedBy.candidateId | string |
候補 ID |
|
参加者 ID
|
data.lastActionPerformedBy.participantId | string |
参加者 ID |
|
タイムスタンプで期限切れ
|
data.expiryAndReminders.expiresAtTimestamp | string |
タイムスタンプでトランザクションの有効期限が切れる |
|
有効期限日
|
data.expiryAndReminders.expiryDays | integer |
有効期限日 |
|
リマインダーの日数を思い出させる
|
data.expiryAndReminders.remindFromReminderDays | integer |
リマインダーの日数を思い出させる |
|
リマインダーの時刻から通知する
|
data.expiryAndReminders.remindFromReminderTime | string |
リマインダーの時刻から通知する |
|
アラームの頻度
|
data.expiryAndReminders.reminderFrequency | integer |
アラームの頻度 |
|
参加者
|
data.participants | array of object |
参加者 |
|
参加者 ID
|
data.participants.id | string |
参加者 ID |
|
参加者の状態
|
data.participants.status | string |
参加者の状態 |
|
最終更新日
|
data.participants.lastUpdatedDate | string |
最終更新日 |
|
作成日
|
data.participants.createdDate | string |
作成日 |
|
参加者のシーケンス
|
data.participants.sequence | integer |
Sequence |
|
Role
|
data.participants.role | string |
Role |
|
署名方法
|
data.participants.signingMethodDTO | array of string |
署名方法の詳細 |
|
ユーザーによって送信
|
data.participants.submittedBys | array of object |
ユーザーの詳細によって送信 |
|
ユーザー ID
|
data.participants.submittedBys.userId | string |
ユーザー ID によって送信 |
|
ユーザー名
|
data.participants.submittedBys.userName | string |
ユーザーの名前で送信 |
|
メール アドレス
|
data.participants.submittedBys.emailAddress | string |
ユーザーの電子メール アドレスによって送信 |
|
候補 ID
|
data.participants.submittedBys.candidateId | string |
候補 ID |
|
候補 者
|
data.participants.candidates | array of object |
候補 者 |
|
候補 ID
|
data.participants.candidates.id | string |
候補 ID |
|
名前
|
data.participants.candidates.name | string |
候補者の名前 |
|
メール アドレス
|
data.participants.candidates.emailAddress | string |
候補者のメール アドレス |
|
Language
|
data.participants.candidates.language | string |
Language |
|
タイプ
|
data.participants.candidates.type | string |
タイプ |
|
アクション
|
data.participants.candidates.action | string |
アクション |
|
アクションの日付
|
data.participants.candidates.actionDate | string |
アクションの日付 |
|
作成日
|
data.participants.candidates.createdDate | string |
作成日 |
|
認証モードの値
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
認証モードの値 |
|
signing メソッドの詳細
|
data.participants.candidates.signingMethodDTO | array of string |
signing メソッドの詳細 |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
配信チャネル
|
data.participants.candidates.deliveryChannels | array of string |
配信チャネル |
|
田畑
|
data.participants.fields | array of object |
田畑 |
|
ID (アイディー)
|
data.participants.fields.id | string |
ID (アイディー) |
|
最終更新日
|
data.participants.fields.lastUpdatedDate | string |
最終更新日 |
|
作成日
|
data.participants.fields.createdDate | string |
作成日 |
|
フィールド ID
|
data.participants.fields.fieldId | string |
フィールド ID |
|
ページいいえ
|
data.participants.fields.pageNo | integer |
ページいいえ |
|
ドキュメント ID
|
data.participants.fields.documentId | string |
ドキュメント ID |
|
フィールドの幅
|
data.participants.fields.width | float |
フィールドの幅 |
|
フィールドの高さ
|
data.participants.fields.height | float |
フィールドの高さ |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
価値
|
data.participants.fields.value | string |
価値 |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
ラベルの表示
|
data.participants.fields.displayLabel | string |
ラベルの表示 |
|
リンクの種類
|
data.participants.fields.linkType | string |
リンクの種類 |
|
無線 ID
|
data.participants.fields.radioId | integer |
無線 ID |
|
無線グループ ID
|
data.participants.fields.radioGroupId | string |
無線グループ ID |
|
チェックボックス ID
|
data.participants.fields.checkboxId | integer |
チェックボックス ID |
|
フィールド名
|
data.participants.fields.fieldName | string |
フィールド名 |
|
X 位置
|
data.participants.fields.xposition | float |
X フィールドの位置 |
|
Y 位置
|
data.participants.fields.yposition | float |
Y フィールドの位置 |
|
必須ですか?
|
data.participants.fields.required | boolean |
これは必須フィールドですか? |
|
読み取り専用ですか?
|
data.participants.fields.readOnly | boolean |
これは読み取り専用フィールドですか? |
|
テキスト領域
|
data.participants.fields.textarea | boolean |
テキスト領域 |
|
垂直
|
data.participants.fields.vertical | boolean |
垂直 |
|
上の下
|
data.participants.fields.topBottom | boolean |
上の下 |
|
デフォルト値
|
data.participants.fields.defaultValue | string |
デフォルト値 |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
ID (アイディー)
|
data.participants.signatureBlock.format.id | string |
ID (アイディー) |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
必須ですか?
|
data.participants.signatureBlock.format.required | boolean |
必須ですか? |
|
既定値
|
data.participants.signatureBlock.default | boolean |
既定値 |
|
デリゲートを有効にする
|
data.participants.enableDelegate | boolean |
デリゲートを有効にする |
|
自動処理
|
data.participants.autoProcess | boolean |
自動処理 |
|
CC ユーザー
|
data.ccUsers | array of object |
CC ユーザー |
|
名前
|
data.ccUsers.name | string |
名前 |
|
メール アドレス
|
data.ccUsers.emailAddress | string |
メール アドレス |
|
Language
|
data.ccUsers.language | string |
Language |
|
ドキュメント
|
data.documents | array of object |
ドキュメント |
|
ドキュメント ID
|
data.documents.id | string |
ドキュメント ID |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
ファイル名
|
data.documents.fileName | string |
ファイル名 |
|
ページ数
|
data.documents.pageCount | integer |
ページ数 |
|
削除可能ですか?
|
data.documents.deletable | boolean |
削除可能ですか? |
|
プライベートである
|
data.documents.private | boolean |
プライベートである |
|
ユーザー設定フィールド
|
data.customFields | array of object |
ユーザー設定フィールド |
|
ユーザー設定フィールド ID
|
data.customFields.customFieldId | string |
ユーザー設定フィールド ID |
|
フィールド値
|
data.customFields.value | string |
フィールド値 |
|
フィールド名
|
data.customFields.fieldName | string |
フィールド名 |
|
フィールドの型
|
data.customFields.fieldType | string |
フィールドの型 |
|
通知サブスクリプション
|
data.notificationSubscriptions | array of |
通知サブスクリプション |
|
tags
|
data.tags | array of |
tags |
|
その他のドキュメント
|
data.additionalDocuments | array of object |
その他のドキュメント |
|
ID (アイディー)
|
data.additionalDocuments.id | string |
ID (アイディー) |
|
ファイル名
|
data.additionalDocuments.fileName | string |
ファイル名 |
|
タイプ
|
data.additionalDocuments.type | string |
タイプ |
|
候補 ID
|
data.additionalDocuments.candidateId | string |
候補 ID |
|
個別契約
|
data.separateAgreements | boolean |
個別契約 |
定義
ファイル
これは基本的なデータ型 'file' です。