Oodrive Sign (プレビュー)
ワークフローを通じて Oodrive sign のサービスに接続して使用します。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Oodrive Sign |
| [URL] | https://www.oodrive.com/products/oodrive-sign/ |
| メール | support-sign@oodrive.com |
| Connector Metadata | |
|---|---|
| 発行者 | Oodrive Sign |
| Web サイト | https://www.oodrive.com/products/oodrive-sign/ |
| プライバシー ポリシー | https://www.oodrive.com/privacy-policy/ |
| カテゴリー | IT Operations;生産性 |
Oodrive Sign のコネクタを使用すると、タスクを自動化し、電子署名エコシステムに関するプロセスを簡単に管理できます。 自動化されたワークフローは、たとえば、テンプレートによって新しい契約書を作成したり、受信者を自動的に追加したり、署名用の契約書を送信したりするよう設計できます。 すべてのバンドル、受信者、キー パラメーターなどを管理することもできます。 これにより、顧客は署名のすべてのプロセス後に手動で行っていた作業時間を短縮できます。 Web アプリケーションで利用可能なすべての機能は、コネクタを使用して Power Automate で再現できます。
前提条件
Oodrive Sign のサービスでは有料プランのアカウントが必要です。
資格情報の入手方法
また、API トークンを取得する必要があります。これは、サポート サービスに依頼するか、Sign のサービスへの申請時にメールボックスに送信されたウェルカム メールから取得できます。
Note: If you are a employee, you can get the token by contacting your IT service.
コネクタの使用を開始する
コネクタの使用を開始するには、まず Power Platform アカウントで Power Automate を開く必要があります。
Note: you'll need to be premium on Power Automate in order to use the connector.
次の手順に従って、新しいワークフローを作成し、コネクタを使用します:
- 自分の Power Automate 環境で、"作成" タブをクリックします。
- 必要に応じて、"自動化されたクラウド フロー" または "インスタント クラウド フロー" を選択します。
- 新しいワークフローに名前を付け、ニーズに合ったトリガーを選択します。 Oodrive Sign のいずれかを使用できます。
- カタログで "Oodrive Sign" を検索するだけで、コネクタからアクションを追加してコネクタの使用を開始します。
- コネクタからアクションまたはトリガーを初めて追加すると、Power Automate から環境に接続するよう求められます : ここで、当社が提供する API トークンを使用します。
- 次に、接続をクリックします : すべてが完了したら、コネクタから必要な数のアクションを使用できます。
既知の問題と制限事項
Oodrive Sign に関する問題については、サポート サービスにお問い合わせください。
一般的なエラーと解決策
HTTP エラー 404
一般に、Oodrive Sign でエラー 404 を受け取った場合は、検索しようとしているリソースが環境に存在しないことを示しています。 通常、存在しない特定の契約または特定の受信者に提供された ID のエラーである可能性があります。 この問題を解決するには、取得しようとしているリソースの既知の ID でアクションを使用してみてください。
HTTP エラー 501
HTTP エラー 501 は、Oodrive Sign のサービスが要求を適切に認識しなかったか、サービスに間違った種類のデータを渡した可能性があることを示しています。 アクションまたはトリガーに渡すデータについて、Sign のドキュメントを読んで調査してみてください。
よくあるご質問
1. ドキュメントを特定の契約書にアップロードするにはどうすればよいですか?
アクション「ドキュメントをアップロードして契約書に添付する」を使用すると、リモートで保存されている pdf ファイルを簡単にアップロードできます。
最初のステップでは、アップロードするファイルのコンテンツを取得する必要があります。 多くのコネクタを使用して取得できます。 たとえば、SharePoint コネクタの「ファイル コンテンツの取得」アクションを使用して、ファイル コンテンツを取得できます。
- 特定の契約書のドキュメントとしてアップロードするファイルのコンテンツを取得します。 この例では、SharePoint オンライン コネクタのアクション「ファイル コンテンツの取得」を使用します。
- 次に、新しい "作成" アクションを追加します。 アクション "ファイル コンテンツの取得" の出力本文を作成の入力として使用します。
- Oodrive Sign コネクタから "ドキュメントをアップロードして契約書に追加する" というアクションを追加します。
- 入力項目 "契約書 ID" に、ドキュメンを添付したい契約の ID を指定します。
- 入力項目 "ファイル" に、前の "作成" アクションの出力を挿入します
- 入力項目 "ファイル (ファイル名)" に、アップロードするドキュメントの名前を挿入します。
- これでドキュメントのアップロードが完了しました!
2. 環境内のすべての契約書を表示できますか?
ユーザーのトークンが "管理者" トークンであれば、表示できます。 そうでない場合は、通常ユーザーにはアクセス権の付与された契約書のみが表示されます。
3. コネクタについて提案があります。 どこに提出すればよいですか?
サポート サービスに連絡して、コネクタに関する提案を提出できます。 皆様のご協力に感謝いたします!
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API キー | securestring | この API の API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| すべての受信者に通知メールを再送信する |
契約書の特定のすべての受信者に通知メールを送信します。 |
| すべての受信者を一覧表示する |
現在のライセンスに関連付けられているすべての受信者を取得します。 |
| すべての契約書の一覧を取得する |
関連するライセンスからすべての契約書を取得します。 |
| すべての範囲を一覧表示する |
接続された環境に関連付けられているすべての境界を取得します。 |
| ドキュメントをアップロードして契約書に添付する |
ドキュメントを環境にアップロードし、特定の契約書に添付します。 |
| バンドルに契約書を追加する |
既存の契約書を既存のバンドルに追加します。 |
| バンドルの契約書を一覧表示する |
特定のバンドルからの契約書を取得します。 |
| バンドルを作成する |
少なくとも 1 つの既存の契約書で新しいバンドルを作成します。 |
| バンドルを取り消す |
バンドル内のすべての契約を取り消します。 |
| バンドル内の契約書を検証する |
バンドル内のすべての契約書に副署 (検証) します。 |
| バンドル取引を停止する |
バンドル取引を停止します。 |
| 受信者に通知メールを再送信する |
契約書の特定の受信者に通知メールを送信します。 |
| 受信者を契約書に追加する |
既存の受信者を契約書に添付します。 |
| 契約の作成 |
環境で新しい契約を作成します。 |
| 契約を取り消す |
契約書が署名用に送信された場合でも、契約書のステータスを ABANDONED に設定します。 |
| 契約書のステータスを取得する |
特定の契約書のステータスを確認します。 |
| 契約書のドキュメントをダウンロードする |
契約書からのすべてのドキュメントを含む PDF ファイルを取得します。 |
| 契約書のドキュメントを一覧表示する |
契約書にバインドされたすべてのドキュメントを取得します。 |
| 契約書の取引を停止する |
契約書のドキュメントや署名者を変更できるように、契約書の取引を停止します。 |
| 契約書の受信者を一覧表示する |
特定の契約書のすべての受信者を取得します。 |
| 契約書の受信者を削除する |
契約書 ID の受信者ごとに、契約書から受信者を削除します。 詳細については、ドキュメントを参照してください。 |
| 契約書の校正ファイルをダウンロードする |
契約書の校正ファイルをダウンロードします。 |
| 契約書の署名を取得する |
特定の契約書からのすべての署名情報を一覧表示します。 |
| 契約書の署名付きドキュメントをダウンロードする |
契約書の署名済みドキュメントから PDF ファイルを取得します。 |
| 契約書を作成して署名用に送信する |
すべてを 1 回の操作で実行します。 契約書を作成し、受信者とドキュメントを追加し、署名用に受信者に送信します。 |
| 契約書を検証する |
契約書を検証 (副署) します。 |
| 添付ファイルをアップロードして契約書に追加する |
新しい添付ファイルを環境にアップロードし、特定の契約書に添付します。 |
| 特定の受信者を取得する |
現在の環境の保存された受信者一覧から特定の受信者を取得します。 |
| 特定の契約書を取得する |
特定の契約書のメタデータを取得します。 |
| 署名する契約書を送信する |
特定の契約書と、受信者が署名するすべてのドキュメントを送信します。 |
| 署名用にバンドルを送信する |
署名用にバンドルを送信します。 |
すべての受信者に通知メールを再送信する
契約書の特定のすべての受信者に通知メールを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
通知を再送信する契約書の ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
通知が正常に再送信されたかどうかを指定します。 |
すべての受信者を一覧表示する
現在のライセンスに関連付けられているすべての受信者を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
規模
|
size | integer |
返される配列の最大サイズ。 |
|
|
ページ
|
offset | integer |
一覧表示された最初の受信者のシーケンス番号。 |
|
|
境界
|
perimeter | string |
指定された境界内のみで検索します。 |
|
|
カスタム プロパティの取得
|
get_custom_props | boolean |
受信者のカスタム プロパティを一覧表示します (応答時間が長くなります)。 |
|
|
境界を取得
|
get_perimeters | boolean |
応答に受信者の範囲を一覧表示します (応答時間が長くなります)。 |
|
|
姓をフィルター処理 (含める)
|
name | string |
姓でフィルタリングします。 |
|
|
メールをフィルター処理 (含める)
|
string |
メールでフィルタリングします。 |
戻り値
- Recipients
- array of Recipient
すべての契約書の一覧を取得する
関連するライセンスからすべての契約書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
返される配列のサイズ
|
size | integer |
返される契約書の配列の最大サイズ。 |
|
|
最初の n 件の契約書をスキップする
|
offset | integer |
スキップする契約書のシーケンス番号。 |
|
|
契約書プロパティの表示
|
get_properties | boolean |
true の場合、契約書プロパティが応答に一覧表示されます。 |
|
|
契約書範囲を表示
|
get_perimeters | boolean |
true の場合、契約書範囲が応答に一覧表示されます。 |
|
|
以前に作成済
|
before | integer |
指定された日付より前に作成された契約書を一覧表示します。 |
|
|
これ以後に作成済
|
after | integer |
指定された日付より後に作成された契約書を一覧表示します。 |
|
|
範囲内のみ
|
perimeter | string |
特定の範囲内のみの契約書を一覧表示します。 |
|
|
ステータス内のみ
|
status | array |
特定のステータス内のみの契約書を取得します。 |
戻り値
- アイテム
- ArrayOfContract
すべての範囲を一覧表示する
ドキュメントをアップロードして契約書に添付する
ドキュメントを環境にアップロードし、特定の契約書に添付します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
新しいドキュメントを添付する契約書の ID。 |
|
File
|
file | file |
アップロードするファイル バイナリ。 |
戻り値
バンドルに契約書を追加する
既存の契約書を既存のバンドルに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル ID
|
id | True | string |
契約書を追加するバンドルの ID。 |
|
契約 Id
|
contract_id | integer |
バンドルに追加する契約書の ID。 |
戻り値
- Body
- BundleResponse
バンドルの契約書を一覧表示する
特定のバンドルからの契約書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル ID
|
id | True | string |
契約を取得するバンドルの ID。 |
戻り値
バンドルを作成する
少なくとも 1 つの既存の契約書で新しいバンドルを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
contract_id | integer |
バンドルの最初の契約書の ID。 |
|
|
同じ署名者
|
same_signatories | boolean |
バンドル内の契約書に同じ一連の署名者がない場合は、false に設定します。 |
戻り値
- Body
- BundleResponse
バンドルを取り消す
バンドル内のすべての契約を取り消します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル ID
|
id | True | string |
すべての契約書を取り消すバンドルの ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
バンドルが取り消されたかどうかを示します。 |
バンドル内の契約書を検証する
バンドル内のすべての契約書に副署 (検証) します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル ID
|
id | True | string |
すべての契約書を検証するバンドルの ID。 |
|
強制検証
|
force | boolean |
一部の署名者がまだ署名していない場合 (または署名を拒否した場合) でも、契約書の検証を強制します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
日にち
|
date | string |
終了ステータスの日付。 |
|
契約 Id
|
id | string |
停止した契約の ID。 |
バンドル取引を停止する
バンドル取引を停止します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル ID
|
id | True | string |
取引を停止するバンドルの ID。 |
|
強制クローズ
|
force | boolean |
署名者がすでに署名している場合でも、取引を強制的に終了します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
バンドルが正常に停止されたことを示します。 |
受信者に通知メールを再送信する
契約書の特定の受信者に通知メールを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
通知を再送信する契約書の ID。 |
|
契約書 ID の受信者
|
cfc_id | True | string |
通知を送信する契約書オブジェクトの受信者の ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
通知が正常に再送信されたかどうかを指定します。 |
受信者を契約書に追加する
既存の受信者を契約書に添付します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
受信者を添付する契約書の ID。 |
|
受信者 ID
|
recipient_id | integer |
契約書に添付する受信者の ID。 |
|
|
署名モード
|
signature_mode | integer |
署名のモード。 詳細については、ドキュメントを参照してください。 |
|
|
メッセージ タイトル
|
message_title | string |
電子メールで送信するメッセージのタイトル (ある場合)。 |
|
|
メッセージ コンテンツ
|
message_body | string |
電子メールで送信するメッセージの本文 (ある場合)。 |
|
|
Rank
|
rank | integer |
署名プロセスにおける受信者の場所。 順位とスマートロールは相互に排他的です。 1 つだけを選択するか、まったく選択しないでください。 |
|
|
スマート ロール名
|
smartrole | string |
受信者に付与するスマート ロール。 詳細については、ドキュメントを参照してください。 |
|
|
輸送のモード
|
transport_mode | integer |
署名の輸送モード。 詳細については、ドキュメントを参照してください。 |
戻り値
契約の作成
環境で新しい契約を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約の名前
|
name | string |
新しく作成した契約の名前 (必須)。 |
|
|
契約定義 ID
|
contract_definition_id | integer |
契約の定義の ID。 ライセンスの API 変数を参照してください。 デフォルトは PDF AdHoc テンプレートです。 |
|
|
ベンダーのメール
|
vendor_email | string |
ライセンス所有者のメール。 |
|
|
作成日
|
date | integer |
契約の日付。 デフォルトは Date.Now()。 ミリ秒でなければなりません。 |
|
|
メッセージ タイトル
|
message_title | string |
送信したメールのオブジェクト。 デフォルトのタイトルの場合は空のままにします。 |
|
|
メッセージの本文
|
message_body | string |
送信したメールの本文。 デフォルト メッセージは空のままにします。 |
|
|
動き続ける
|
keep_on_move | boolean |
モバイル デバイスでオフライン署名を有効にするかどうか |
|
|
自動クローズ
|
auto_close | integer |
人間の介入なしで副署が実行されるかどうかを指定します。 |
|
|
シーケンシャル
|
sequential | boolean |
順次かどうかを指定します。 |
|
|
顧客番号
|
customer_number | string |
従来のモバイル アプリケーションの互換性のみを目的としています。 |
|
|
境界の一覧
|
perimeters | array of string | ||
|
要素定義 ID
|
element_definition_id | integer |
要素の定義 ID。 |
|
|
価値
|
value | string |
要素オプションの値。 |
|
|
プロパティ ID
|
id | integer |
カスタム プロパティの ID。 |
|
|
プロパティ キー
|
key | string |
カスタム プロパティのキー。 |
|
|
プロパティ プレースホルダー
|
placeholder | string |
プロパティへの入力を求められたときに受信者に表示されるラベル。 |
|
|
プロパティ値
|
value | string |
カスタム プロパティの値。 |
|
|
プロパティ契約書 ID
|
contract_id | integer |
このカスタム プロパティに関連付けられた契約書の ID。 |
|
|
プロパティが必須
|
to_fill_by_user | boolean |
ユーザーがプロパティを入力する必要があるかどうかを指定します。 |
|
|
プロパティの種類
|
field_type | string |
カスタム プロパティのタイプを指定します。 詳細については、ドキュメントを参照してください。 |
|
|
プロパティの選択
|
input_filter | string |
プロパティの可能な選択肢の一覧。 |
|
|
契約書で使用されるプロパティ
|
used_by_contract | boolean |
契約文書に情報を表示する必要がある場合は、true に設定します。 |
|
|
プロパティが必須
|
required | boolean |
プロパティが必要かどうかを指定します。 |
戻り値
- Body
- Contract
契約を取り消す
契約書が署名用に送信された場合でも、契約書のステータスを ABANDONED に設定します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
取り消す契約書の ID。 |
|
Reason
|
reason | string |
取り消しの理由。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
契約が解除されたかどうかを指定します。 |
契約書のステータスを取得する
特定の契約書のステータスを確認します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | integer |
ステータスを取得する契約書の ID。 |
戻り値
- Body
- Transaction
契約書のドキュメントをダウンロードする
契約書からのすべてのドキュメントを含む PDF ファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
pdf ファイルを取得する契約書の ID。 |
|
出力ファイル名
|
filename | string |
ダウンロードされるファイルの名前。 |
戻り値
- PDF ドキュメント バイナリ
- file
契約書のドキュメントを一覧表示する
契約書にバインドされたすべてのドキュメントを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
ドキュメントを取得する契約書の ID。 |
戻り値
契約書の取引を停止する
契約書のドキュメントや署名者を変更できるように、契約書の取引を停止します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
停止する契約書の ID。 |
|
Force
|
force | boolean |
署名者がすでに署名している場合でも、取引を強制的に終了します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
契約が解除されたかどうかを指定します。 |
契約書の受信者を一覧表示する
特定の契約書のすべての受信者を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
すべての受信者を取得する契約書の ID。 |
戻り値
契約書の受信者を削除する
契約書 ID の受信者ごとに、契約書から受信者を削除します。 詳細については、ドキュメントを参照してください。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約書 ID の受信者
|
cfc_id | True | string |
削除する契約書オブジェクトの受信者の ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
受信者が正常に削除されたかを指定します。 |
契約書の校正ファイルをダウンロードする
契約書の校正ファイルをダウンロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
校正ファイルをダウンロードする契約書の ID。 |
|
出力ファイル名
|
filename | string |
ダウンロードされるファイルの名前。 |
戻り値
- 返答
- file
契約書の署名を取得する
特定の契約書からのすべての署名情報を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
すべての署名を一覧表示する契約書の ID。 |
戻り値
契約書の署名付きドキュメントをダウンロードする
契約書の署名済みドキュメントから PDF ファイルを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | integer |
ドキュメントを含む契約書の ID。 |
|
File name
|
filename | string |
ダウンロードしたドキュメントに付ける名前。 |
戻り値
pdf ファイルのバイナリ コンテンツ。
- ドキュメント バイナリ
- file
契約書を作成して署名用に送信する
すべてを 1 回の操作で実行します。 契約書を作成し、受信者とドキュメントを追加し、署名用に受信者に送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
contract_id | integer |
契約書の ID。 |
|
|
作成日
|
date | integer |
契約書が作成された日付。 |
|
|
ベンダーの電子メール アドレス
|
vendor_email | string |
Oodrive のライセンス所有者の電子メール アドレス。 |
|
|
契約定義 ID
|
contract_definition_id | integer |
この契約書に使用される契約定義の ID。 |
|
|
メッセージの件名
|
message_title | string |
署名用に送信される電子メールの件名。 |
|
|
メッセージの本文
|
message_body | string |
署名用に送信される電子メールの本文。 |
|
|
契約名
|
name | True | string |
契約書の主要なドキュメント名。 |
|
オフライン署名のアクティブ化
|
keep_on_move | boolean |
モバイル デバイスのオフライン署名が有効になっているかどうかを確認します。 |
|
|
契約終了日
|
closed_date | integer |
契約の終了日 (ある場合)。 |
|
|
契約が解除された理由
|
canceled_reason | string |
キャンセルの理由 (ある場合)。 |
|
|
自動終了の有効化
|
auto_close | integer |
契約が自動的に副署されるか、人の介入が必要かを指定します。 |
|
|
Is Deleted
|
deleted | integer |
契約が削除されたかどうかを指定します。 |
|
|
範囲キー
|
Perimeters | string |
範囲のキー。 |
|
|
オプション ID
|
id | integer |
契約のオプションの ID。 |
|
|
契約 Id
|
contract_id | integer |
このオプションをバインドする契約書の ID。 |
|
|
要素定義 ID
|
element_definition_id | integer |
オプションの要素定義の ID。 |
|
|
同期タイマー
|
sync_timer | integer |
同期問題で使用されるタイマー。 |
|
|
オプションの値
|
value | string |
オプションの値。 |
|
|
最終変更場所
|
last_modification_place | string |
最後の変更が行われた場所を示します。 |
|
|
オプション コントロール
|
control | string |
フィールドをコントロールします。 |
|
|
プロパティ ID
|
id | integer |
カスタム プロパティの ID。 |
|
|
プロパティ キー
|
key | string |
カスタム プロパティのキー。 |
|
|
プロパティ プレースホルダー
|
placeholder | string |
プロパティへの入力を求められたときに受信者に表示されるラベル。 |
|
|
プロパティ値
|
value | string |
カスタム プロパティの値。 |
|
|
プロパティ契約書 ID
|
contract_id | integer |
このカスタム プロパティに関連付けられた契約書の ID。 |
|
|
プロパティが必須
|
to_fill_by_user | boolean |
ユーザーがプロパティを入力する必要があるかどうかを指定します。 |
|
|
プロパティの種類
|
field_type | string |
カスタム プロパティのタイプを指定します。 詳細については、ドキュメントを参照してください。 |
|
|
プロパティの選択
|
input_filter | string |
プロパティの可能な選択肢の一覧。 |
|
|
契約書で使用されるプロパティ
|
used_by_contract | boolean |
契約文書に情報を表示する必要がある場合は、true に設定します。 |
|
|
プロパティが必須
|
required | boolean |
プロパティが必要かどうかを指定します。 |
|
|
署名モード
|
signature_mode | integer | ||
|
firstname
|
firstname | string | ||
|
lastname
|
lastname | string | ||
|
メールアドレス
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
pdfparts
|
pdfparts | string | ||
|
appendixparts
|
appendixparts | string |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
契約
|
contract | Contract | |
|
PDF
|
pdfparts | array of object |
契約書にバインドされた PDF の配列。 |
|
PDF ID
|
pdfparts.id | integer |
PDF の ID。 |
|
PDF 順位
|
pdfparts.rank | integer |
PDF の順位。 |
|
SmartFields があるかどうか
|
pdfparts.has_smart_field | boolean |
契約書にスマート フィールドがあるかどうかを指定します。 |
|
PDF サイズ
|
pdfparts.size | integer |
ドキュメントのサイズ。 |
|
File name
|
pdfparts.filename | string |
pdf の名前。 |
|
appendixparts
|
appendixparts | array of object | |
|
id
|
appendixparts.id | integer |
契約書を検証する
契約書を検証 (副署) します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
検証する契約書の ID。 |
|
Force
|
force | boolean |
一部の署名者がまだ署名していない場合でも、契約書の検証を強制する必要があるかどうかを指定します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
検証日
|
date | string |
検証の日付。 |
|
Transaction ID
|
id | string |
証明機関のトランザクション ID。 |
添付ファイルをアップロードして契約書に追加する
新しい添付ファイルを環境にアップロードし、特定の契約書に添付します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
添付ファイルに追加する契約書の ID。 |
|
契約定義 ID
|
contract_definition_id | integer |
環境で定義された契約定義 ID。 既定値は pdfadhoc です。 |
|
|
オプションの定義名
|
option_definition_name | string |
定義名。 |
|
|
Files
|
file | array |
ファイルを添付書類として追加します |
戻り値
- Body
- AppendixAdded
特定の受信者を取得する
現在の環境の保存された受信者一覧から特定の受信者を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
受信者 ID
|
id | True | string |
取得する受信者の ID。 |
戻り値
- Body
- Recipient
特定の契約書を取得する
署名する契約書を送信する
特定の契約書と、受信者が署名するすべてのドキュメントを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
契約 Id
|
id | True | string |
署名のために送信する契約書の ID。 |
戻り値
- Body
- Transaction
署名用にバンドルを送信する
署名用にバンドルを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル ID
|
id | True | string |
署名のために送信するバンドルの ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
成功
|
succeed | boolean |
トランザクションが送信されたかどうかを示します。 |
トリガー
| 契約書のステータスが変更された場合 |
この操作は、契約書のステータスが変更されるたびにトリガーされます。 |
契約書のステータスが変更された場合
この操作は、契約書のステータスが変更されるたびにトリガーされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
description
|
description | string |
description |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
境界
|
perimeter | array of integer |
境界 |
|
|
concernedUserEmail
|
concernedUserEmail | string |
concernedUserEmail |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
タイプ
|
type | string |
タイプ |
|
contractId
|
contractId | integer |
contractId |
|
timestamp
|
timestamp | integer |
timestamp |
|
contractStatus
|
contractStatus | string |
contractStatus |
定義
ArrayOfContract
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
Contract |
契約
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約 Id
|
contract_id | integer |
契約書の ID。 |
|
作成日
|
date | integer |
契約書が作成された日付。 |
|
ドキュメント トークン
|
document_token | string |
契約書のメイン ドキュメントのトークン。 |
|
ベンダーの電子メール アドレス
|
vendor_email | string |
Oodrive のライセンス所有者の電子メール アドレス。 |
|
閉じています
|
closed | boolean |
契約が終了するかどうかを指定します。 |
|
契約の状態
|
status | string |
契約書の現在の状態。 |
|
契約定義 ID
|
contract_definition_id | integer |
この契約書に使用される契約定義の ID。 |
|
メッセージの件名
|
message_title | string |
署名用に送信される電子メールの件名。 |
|
メッセージの本文
|
message_body | string |
署名用に送信される電子メールの本文。 |
|
契約名
|
name | string |
契約書の主要なドキュメント名。 |
|
オフライン署名のアクティブ化
|
keep_on_move | boolean |
モバイル デバイスのオフライン署名が有効になっているかどうかを確認します。 |
|
契約終了日
|
closed_date | integer |
契約の終了日 (ある場合)。 |
|
契約が解除された理由
|
canceled_reason | string |
キャンセルの理由 (ある場合)。 |
|
契約書バージョン番号
|
version_number | integer |
契約のバージョン番号です。 |
|
契約書サイズ
|
size | integer |
契約書のフル サイズ。 |
|
自動終了の有効化
|
auto_close | integer |
契約が自動的に副署されるか、人の介入が必要かを指定します。 |
|
Is Deleted
|
deleted | integer |
契約が削除されたかどうかを指定します。 |
|
境界
|
perimeters | array of ContractPerimeterKey |
契約書のすべての範囲を一覧表示します (照会された場合)。 |
|
オプション
|
options | array of ContractOption |
契約書のすべての特定オプションを一覧表示します (照会された場合)。 |
|
カスタム プロパティ
|
contract_properties | array of ContractProperty |
契約書プロパティのすべてのオプションを一覧表示します (照会された場合)。 |
ContractOption
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
オプション ID
|
id | integer |
契約のオプションの ID。 |
|
契約 Id
|
contract_id | integer |
このオプションをバインドする契約書の ID。 |
|
要素定義 ID
|
element_definition_id | integer |
オプションの要素定義の ID。 |
|
同期タイマー
|
sync_timer | integer |
同期問題で使用されるタイマー。 |
|
オプションの値
|
value | string |
オプションの値。 |
|
最終変更場所
|
last_modification_place | string |
最後の変更が行われた場所を示します。 |
|
オプション コントロール
|
control | string |
フィールドをコントロールします。 |
ContractProperty
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロパティ ID
|
id | integer |
カスタム プロパティの ID。 |
|
プロパティ キー
|
key | string |
カスタム プロパティのキー。 |
|
プロパティ プレースホルダー
|
placeholder | string |
プロパティへの入力を求められたときに受信者に表示されるラベル。 |
|
プロパティ値
|
value | string |
カスタム プロパティの値。 |
|
プロパティ契約書 ID
|
contract_id | integer |
このカスタム プロパティに関連付けられた契約書の ID。 |
|
プロパティが必須
|
to_fill_by_user | boolean |
ユーザーがプロパティを入力する必要があるかどうかを指定します。 |
|
プロパティの種類
|
field_type | string |
カスタム プロパティのタイプを指定します。 詳細については、ドキュメントを参照してください。 |
|
プロパティの選択
|
input_filter | string |
プロパティの可能な選択肢の一覧。 |
|
契約書で使用されるプロパティ
|
used_by_contract | boolean |
契約文書に情報を表示する必要がある場合は、true に設定します。 |
|
プロパティが必須
|
required | boolean |
プロパティが必要かどうかを指定します。 |
ContractPerimeterKey
ContractRecipient
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約書 ID の受信者
|
recipient_for_contract_id | integer |
対になる契約書と受信者の一意の識別子。 |
|
受信者 ID
|
recipient_id | integer |
受信者の ID。 |
|
契約 Id
|
contract_id | integer |
契約書の ID。 |
|
署名ステータス
|
signature_status | string |
署名マークのステータス。 |
|
Signature date
|
signature_date | integer |
署名マークの日付のタイムスタンプ。 |
|
署名モード
|
signature_mode | integer |
署名マーク モード。 |
|
メッセージ タイトル
|
message_title | string |
メッセージのタイトル。 |
|
メッセージ コンテンツ
|
message_body | string |
メッセージの本文。 |
|
Rank
|
rank | integer |
署名プロセスでの順位。 |
|
スマート ロール
|
smartrole | string |
受信者に関連付けられたスマート ロール。 |
|
輸送のモード
|
transport_mode | integer |
転送モード。 |
|
署名 ID
|
signature_id | string |
受信者からの署名の ID。 |
DocumentAdded
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Document ID
|
id | integer |
ドキュメントの ID。 |
|
Rank
|
rank | integer |
ドキュメントの一覧に配置します。 |
|
SmartField があるかどうか
|
has_smart_field | boolean |
ドキュメントに SmartField があるかどうかを指定します。 |
|
ドキュメントのサイズ
|
size | integer |
ドキュメントのサイズ (バイト数)。 |
|
ドキュメント名
|
filename | string |
ドキュメントの名前。 |
トランザクション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約書トランザクション ID
|
transaction_id | string |
契約書にバインドされたトランザクション ID を指定します。 |
|
閉じています
|
is_closed | boolean |
契約が終了するかどうかを指定します。 |
|
契約名
|
contract_name | string |
契約の名前。 |
|
契約の状態
|
status | string |
契約書のステータスを指定します。 |
境界
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
境界 ID
|
id | integer |
境界の ID。 |
|
境界キー
|
key | string |
境界のキー (契約書で使用)。 |
|
description
|
description | string |
境界の説明。 |
RecipientForContractWithRefusal
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約書 ID の受信者
|
recipient_for_contract_id | integer |
契約書と受信者をバインドするオブジェクトの ID。 |
|
受信者 ID
|
recipient_id | integer |
署名の受信者の ID。 |
|
署名ステータス
|
signature_status | string |
署名のステータス。 |
|
Signature date
|
signature_date | integer |
署名の最終変更日。 |
|
署名モード
|
signature_mode | integer |
署名のモード。 |
|
メッセージ タイトル
|
message_title | string |
契約書の署名にバインドされたメッセージのタイトル。 |
|
メッセージ コンテンツ
|
message_body | string |
契約書の署名にバインドされたメッセージの本文。 |
|
Rank
|
rank | integer |
契約プロセスにおける署名の受信者の順位。 |
|
スマート ロール名
|
smartrole | string |
契約における署名の受信者のロール。 |
|
輸送のモード
|
transport_mode | integer |
署名にバインドされた契約書の輸送モード。 |
|
署名 ID
|
signature_id | string |
署名の ID。 |
|
拒否されるかどうか
|
has_refusal | boolean |
受信者が契約を拒否したかどうかを指定します。 |
|
最終拒否日
|
last_refusal_date | integer |
拒否日を指定します。 |
|
最後の拒否メッセージ
|
last_refusal_message | string |
拒否メッセージを指定します。 |
ContractInBundle
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
契約 Id
|
id | integer |
契約書の ID。 |
|
契約名
|
name | string |
契約の名前。 |
|
契約定義のタイプ
|
contract_definition_type | string |
契約の定義の種類。 |
|
契約定義 ID
|
contract_definition_id | integer |
契約の定義の ID。 |
|
Company name
|
company_name | string |
契約書にバインドされる会社の名前。 |
Recipient
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
受信者 ID
|
id | integer |
受信者の ID。 |
|
礼儀正しさ
|
civility | string |
受信者の礼儀正しさ |
|
First Name
|
firstname | string |
受信者の名。 |
|
Last Name
|
lastname | string |
受信者の姓。 |
|
代表住所
|
address_1 | string |
受信者のメイン住所。 |
|
Postal Code
|
postal_code | string |
受信者の郵便番号。 |
|
都市
|
city | string |
受信者の市区町村。 |
|
携帯電話番号
|
cell_phone | string |
受信者の携帯電話番号。 |
|
メール アドレス
|
string |
受信者のメール アドレス。 |
|
|
Country
|
country | string |
受信者の国。 |
|
セカンダリ住所
|
address_2 | string |
受信者のセカンダリ住所。 |
|
Company Name
|
company_name | string |
受信者の会社名。 |
|
電話番号
|
phone | string |
受信者の電話番号。 |
|
役職
|
job_title | string |
受信者の役職。 |
|
生年月日
|
birthdate | integer |
受信者の生年月日 (タイムスタンプ)。 |
|
出生地
|
birthplace | string |
受信者の出生地。 |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
境界
|
perimeters | array of string |
RecipientProperty
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロパティ ID
|
id | integer |
プロパティの ID。 |
|
プロパティ キー
|
key | string |
プロパティのキー。 |
|
プロパティ値
|
value | string |
プロパティの値。 |
|
担当請負業者 ID
|
contractor_id | integer |
担当請負業者の ID。 |
|
同期タイマー
|
sync_timer | integer |
最終同期のタイマー。 |
|
最終変更場所
|
last_modification_place | string |
最終変更の場所。 |
AppendixAdded
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
付録 ID
|
id | integer |
付録の ID。 |
|
付録名
|
filename | string |
付録の名前。 |
|
付録オプション ID
|
option_id | integer |
付録のオプション ID |
|
付録コンテンツ タイプ
|
content_type | string |
付録のコンテンツ タイプ (image/jpeg など)。 |
BundleResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バンドル ID
|
id | integer |
バンドルの ID。 |
|
作成者 ID
|
actor_id | integer |
バンドルの作成者の ID。 |
|
初回契約書 ID
|
contract_id | integer |
作成されたバンドルの初回契約書の ID。 |
|
バンドル ステータス
|
status | integer |
バンドルのステータス。 |
|
バンドル マスター
|
master | integer |
バンドルのマスター。 |
file
これは基本的なデータ型 'ファイル' です。