Lex Power Sign (プレビュー)
Lex Persona は、さまざまな電子署名ソリューションを提供するヨーロッパの認定トラスト サービス プロバイダーです。 Lex Enterprise を使用すると、すべての eIDAS 署名レベルに加えて、多数の署名者認証方法にアクセスできます。 署名簿はデジタル ワークフローに埋め込まれます。 Lex Enterprise とすべてのツール間の接続を自動化することで、反復的なタスクを排除し、効率を高め、ビジネスを加速します。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Lex Persona のサポート |
| [URL] | https://support.lex-persona.com |
| メール | support@lex-persona.com |
| Connector Metadata | |
|---|---|
| 発行者 | Lex Persona |
| Web サイト | https://www.lex-persona.com |
| プライバシー ポリシー | https://www.lex-persona.com/politique-de-confidentialite/ |
| カテゴリー | AI、Web サイト |
Lex Persona は、さまざまな電子署名ソリューションを提供するヨーロッパの認定トラスト サービス プロバイダーです。 このコネクタを使用すると、Microsoft ベースのアプリケーション (PowerApp、.NET ベースの Web アプリ、Dynamics など) および環境 (Outlook、Sharepoint、Teams など) に電子署名機能を簡単に追加できます。このコネクタは、Lex Enterprise Workflow マネージャーによってサポートされています。 順番または並行して実行できるさまざまなタイプのステップで構成される電子署名ワークフローを作成できます。 コネクタは、すべての eIDAS 署名レベルをサポートし、幅広い署名者認証方法 (OTP、SSO、France Connect、Identité Numérique La Poste、ハードウェア トークンなど) を提供します。
前提条件
手続きには以下のものが必要です:
- Lex Enterprise のサブスクリプション。 試用版プランを使用してテストしてください
環境要件は次のとおりです:
- カスタム コネクタ機能を備えた Microsoft Power Apps または Power Automate プラン
- Power Platform の CLI ツール
資格情報の入手方法
Lex Enteprise サブスクリプションまたは試用システムのアカウントを取得するには、commercial@lex-persona.com の営業担当者にお問い合わせください。
自分のアカウントで Lex Enterprise ポータルに接続し、API キーを生成します。
コネクタの使用を開始する
まず、コネクタの接続を作成します。 認証方法を APIキー に設定し、APIキー ("bearer act_XXXXXXX") を提供し、API コールの Autorization ヘッダーに API キーを配置する必要があることを指定します。
シンプルな署名ワークフローを作成する手順は以下の通りです:
- Tigger の直後に、Retrieve Me アクションで接続されている Lex Enterprise ユーザー ID (この ID はワークフローを作成するために必要です) を取得します
- 同意ページを検索 action_ で同意ページを検索します。 text パラメータを使用して、同意ページを名前で検索できます (同意ページは署名レベルを定義し、Lex Enterprise 環境で事前構成されています)
- ワークフローの作成 アクションを使用して署名ワークフローを作成します。 このステップでは、署名者の情報を提供する必要があります。
- 署名プロファイルの検索アクション を使用して署名プロファイルを検索します。 text パラメータを使用して、名前で署名プロファイルを検索できます (署名プロファイルは、同意ページの動作の一部の側面を制御します。 たとえば、署名する前に署名者にドキュメントの一番下までスクロールさせます
- 環境からドキュメントを取得します (Sharepoint、Outlook、OneDrive...)
- パーツの作成 アクションを使用してドキュメントをワークフローに追加し、createDocumentパラメータを true に設定します
- ワークフローを更新 アクションでワークフローを開始し、ワークフローステータス を 開始に設定します
注意: コネクタは既定で試用版サーバーとペアリングされています。 コネクタを独自のテナントとペアにする場合は、コネクタのセキュリティ定義または apiDefinitions.jso ファイルでホスト URL を変更する必要があります。
- "ホスト": "yourtenant.lexpersona.com",
既知の問題と制限事項
ドキュメントの作成 アクションは、ペイロード内のドキュメント パーツのリストを受け入れます。 ただし、複数の部分を指定した場合は、最初の部分のみが考慮されます (これは API のバグによるものです)。 これはコネクタの次のリリースで修正される予定です)。
そのため、複数のドキュメントをワークフローに追加したい場合は、各ドキュメントに createDocument パラメータを true に設定して Create part を呼び出す必要があります。
一般的なエラーと解決策
API 呼び出しが失敗した場合、API 呼び出し応答には、コネクタの実行履歴に表示される包括的なエラー メッセージが含まれます。 メッセージにはログ ID も含まれているため、エラーに関する詳細情報が必要な場合は、Lex Enteprise ポータルに接続してサーバー ログ ファイルを参照できます。 あるいは、サーバー ログを検索するための Postman リクエストを設定することもできます (ドキュメント: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs) を参照してください。
API によって返される一般的な HTTP エラー コードは次のとおりです:
- エラー 400 - 不正な要求によるエラーです。 リクエストのペイロードに問題があります。 ログを参照して、エラーの原因に関する情報を見つけます
- エラー 401 - 未承認。 Yo にはこの操作を実行するアクセス権がありません。 Lex Persona ユーザーのアクセス権を確認する
- エラー 403 - 許可されていません。 API キーが無効または無効になっています
- エラー 404 - ファイルが見つかりませんでした。 リクエスト URL にエラーがあります
各 API 呼び出しのエラーコード (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html) の詳細については、ドキュメントを参照してください
よくあるご質問
コネクタでサポートされているドキュメント形式は何ですか
署名のために送信できるドキュメントには、pdf、docx、pptx、xlsx 形式を使用できます。 コネクタは必要に応じてドキュメントを PDF に変換し、署名は PAdES 形式になります。
XML ドキュメントに署名することもできます。 この場合、変換は適用されず、署名は XAdES 形式になります。
zip ファイルをアップロードすることも可能です。 コネクタはアーカイブを解凍し、各ドキュメントをワークフローに追加します。
署名ワークフローに添付ファイルを追加することもできます。 添付ファイルは署名されておらず、任意の形式を使用できます。
ドキュメントに複数の署名者が存在することはできますか
はい 文書の署名者の数は無制限です。
一度に複数の書類に署名することは可能ですか
はい 複数のドキュメントをワークフローに追加でき、すべてのドキュメントが同時に署名されます。 ただし、この場合、一連の文書が法的にリンクされ、システムが固有の証拠ファイルを生成することに注意してください。
同じ署名者を含む複数のワークグローを作成することもできます。 署名時には、文書のリストが署名者に提示され、署名者は署名したい文書を選択する機会が与えられます。 この場合、文書ごとに証拠ファイルが作成されるため、文書は法的に独立したものになります。
オフラインで文書に署名することは可能ですか
いいえ 同意ページにアクセスするには、インターネット接続が必要です。
署名者に自動署名リマインダーを送信することはできますか
はい リマインダーの期間と送信するリマインダーの最大数を設定できます。
すでに開始されている署名ワークフローを変更することはできますか
はい 署名の前に、ワークフロー内のあらゆるものを変更できます。 最初の署名の後はドキュメントを変更することはできませんが、ワークフロー ステップを変更することはできます。
ワンタイムパスワードの有効期間はどれくらいですか
ワンタイム パスワードの有効期間は 2 分です (同意ページにカウントダウンが表示されます)。
電子署名の有効性を検証することはできますか
Adobe Acrobat の**署名ペイン** を使えば、pdf ドキュメントに含まれる署名の有効性をチェックすることができます。 あるいは、信頼できる署名検証 Web サービス (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation など)
Lex Persona 文書の保管条件は何ですか
既定では、文書と証拠ファイルはサーバーに保存されます。 いつでもドキュメントを検索してダウンロードできます。 ただし、ご要望があれば、サーバーからドキュメントを定期的に削除することができます。
Lex Personaはタイムスタンプ トークンを保持しますか
いいえ タイムスタンプ トークンは保持しません。 必要に応じて、署名された文書からこれらのトークンを抽出できます。
署名された文書に取り消し期間はありますか
はい 撤回期間は、文書に適用される法的条件によって異なります。
署名ワークフローをキャンセルすることはできますか
はい authoriezd ユーザーは、開始された署名ワークフローをいつでもキャンセルできます。 証拠ファイルは作成されず、文書に 1 人または複数の署名者がすでに署名している場合、その署名は無効になります。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API キー | securestring | この API の API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| エビデンス ファイルをダウンロードする |
ワークフロー エビデンス ファイルをダウンロードします |
| ドキュメントの作成 |
以前に作成したパーツからドキュメントを作成します |
| ドキュメントの更新 |
ドキュメントを更新する |
| ドキュメントを削除する |
ドキュメントを削除します |
| ドキュメントを取得する |
ドキュメントを取得する |
| ドキュメントを検索する |
ドキュメントを検索する |
| パーツを作成する |
ドキュメント パーツを作成します |
| メタデータ マッピングを取得する |
指定したテナントのメタデータ マッピングを取得します |
| メタデータ レイアウトを作成する |
メタデータ レイアウトを作成します |
| メタデータ レイアウトを取得する |
ワークフロー レイアウトを取得します |
| メタデータ レイアウトを更新する |
メタデータ レイアウトを更新します |
| メタデータ レイアウトを検索する |
ワークフロー レイアウトを検索する |
| ワークフロー ドキュメントをダウンロードする |
ワークフロー ドキュメントをダウンロードします |
| ワークフローを作成する |
ワークフローを作成する |
| ワークフローを削除する |
ワークフローを削除する |
| ワークフローを取得する |
ワークフロー ID でワークフローを取得します |
| ワークフローを更新する |
ワークフローを更新します |
| ワークフローを検索する |
ワークフローを検索する |
| 取引先担当者の削除 |
現在のユーザーの取引先担当者一覧から取引先担当者を削除します |
| 取引先担当者の検索 |
取引先担当者の検索 |
| 取引先担当者を取得する |
取引先担当者 ID で取引先担当者情報を取得します |
| 同意ページ URL の取得 |
受信者の同意ページ URL を作成および取得します |
| 同意ページの取得 |
同意ページ ID から同意ページ情報を取得します |
| 同意ページを検索する |
同意ページを検索する |
| 署名プロファイルを作成する |
署名プロファイルを作成します |
| 署名プロファイルを取得する |
署名プロファイルを取得します |
| 署名プロファイルを更新する |
署名プロファイルを更新します |
| 署名プロファイルを検索する |
署名プロファイルを検索する |
| 自分を取得する |
接続されているユーザー ID を取得します |
| 連絡先の作成 |
現在のユーザーの取引先担当者一覧に取引先担当者を追加します |
| 連絡先の更新 |
既存の取引先担当者情報を更新します |
エビデンス ファイルをダウンロードする
ワークフロー エビデンス ファイルをダウンロードします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
ワークフローの ID |
|
Accept
|
Accept | True | string |
Accept |
戻り値
- 返答
- binary
ドキュメントの作成
以前に作成したパーツからドキュメントを作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
接続されるワークフローの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
contentType
|
contentType | string |
contentType |
|
|
ファイル名
|
filename | string |
ファイル名 |
|
|
ハッシュ
|
hash | string |
ハッシュ |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
このドキュメントの署名プロファイル |
戻り値
- Body
- document
ドキュメントの更新
ドキュメントを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document Id
|
documentId | True | string |
ドキュメントの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
signatureProfileId
|
signatureProfileId | string |
このドキュメントに適用する署名プロファイル |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
戻り値
- Body
- document
ドキュメントを削除する
ドキュメントを取得する
ドキュメントを検索する
ドキュメントを検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索テキスト
|
text | string |
検索テキスト |
|
|
メタデータ レイアウトを検索する
|
items.layoutId | string |
メタデータ レイアウトで検索します |
|
|
グループを検索する
|
items.groupId | string |
ユーザーのグループで検索します |
|
|
ユーザーの検索
|
items.userId | string |
所有者で検索します |
|
|
ワークフロー ID を検索する
|
items.workflowId | string |
ワークフロー ID で検索します |
|
|
ワークフロー名を検索する
|
items.workflowName | string |
ワークフロー名で検索します |
|
|
メタデータ 1 を検索する
|
items.data1 | string |
メタデータ 1 の値で検索します |
|
|
メタデータ 2 を検索する
|
items.data2 | string |
メタデータ 2 の値で検索します |
|
|
メタデータ 3 を検索する
|
items.data3 | string |
メタデータ 3 の値で検索します |
|
|
メタデータ 4 を検索する
|
items.data4 | string |
メタデータ 4 の値で検索します |
|
|
メタデータ 5 を検索する
|
items.data5 | string |
メタデータ 5 の値で検索します |
|
|
メタデータ 6 を検索する
|
items.data6 | string |
メタデータ 6 の値で検索します |
|
|
メタデータ 7 を検索する
|
items.data7 | string |
メタデータ 7 の値で検索します |
|
|
メタデータ 8 を検索する
|
items.data8 | string |
メタデータ 8 の値で検索します |
|
|
署名プロファイルを検索する
|
items.signatureProfileId | string |
署名プロファイルで検索します |
|
|
作成日付を検索する
|
items.created | string |
作成日付で検索します |
|
|
更新日を検索する
|
items.updated | string |
最終更新日で検索します |
|
|
並べ替え順
|
sortBy | string |
検索結果を並べ替えるために使用するフィールド |
|
|
並べ替え順序
|
sortOrder | string |
並べ替えの指示 |
|
|
ページあたりの項目数
|
itemsPerPage | string |
応答のページあたりの項目数 |
|
|
ページ インデックス
|
pageIndex | string |
返されるページのインデックス |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | documents |
パーツを作成する
ドキュメント パーツを作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
接続されるワークフローの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
Content-Disposition
|
Content-Disposition | True | string |
Content-Disposition |
|
ドキュメントを作成する
|
createDocuments | string |
このパーツからドキュメントを作成します |
|
|
添付ファイルを無視する
|
ignoreAttachments | string |
添付ファイルが無視されます |
|
|
署名プロファイル ID
|
signatureProfileId | string |
省略した場合、パーツは添付ファイルとみなされます |
|
|
解凍
|
unzip | string |
zip ファイルの解凍 |
|
|
PDF から PdfA へ
|
pdf2pdfa | string |
PDF を pdf/A に変換します |
|
|
Document
|
document | True | binary |
アップロードされたファイル データ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
documents
|
documents | array of document |
作成されたドキュメント |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
パーツ
|
parts | array of part |
パーツ |
メタデータ マッピングを取得する
指定したテナントのメタデータ マッピングを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テナント ID です
|
tenantId | True | string |
テナントの ID |
戻り値
- Body
- dataMapping
メタデータ レイアウトを作成する
メタデータ レイアウトを作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テナント ID です
|
tenantId | True | string |
レイアウトの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
件名
|
name | True | string |
レイアウト名 |
|
無効である
|
isDisabled | boolean |
true に設定すると、レイアウトが無効になります |
|
|
時間帯
|
slot | string |
メタデータ項目 (data1 から data8) |
|
|
default
|
default | string |
このレイアウトのメタデータの既定値 |
|
|
オプション
|
optional | boolean |
true の場合、値の指定は必須ではありません |
|
|
readonly
|
readonly | boolean |
値を上書きできるかどうか |
|
|
rememberLastValue
|
rememberLastValue | boolean |
true に設定すると、値はワークフロー間で保持されます |
戻り値
メタデータ レイアウト
- Body
- layout
メタデータ レイアウトを取得する
ワークフロー レイアウトを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レイアウト ID
|
layoutId | True | string |
レイアウトの ID |
戻り値
メタデータ レイアウト
- Body
- layout
メタデータ レイアウトを更新する
メタデータ レイアウトを更新します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テナント ID です
|
layoutId | True | string |
レイアウトの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
件名
|
name | True | string |
レイアウト名 |
|
無効である
|
isDisabled | boolean |
true に設定すると、レイアウトが無効になります |
|
|
時間帯
|
slot | string |
メタデータ項目 (data1 から data8) |
|
|
default
|
default | string |
このレイアウトのメタデータの既定値 |
|
|
オプション
|
optional | boolean |
true の場合、値の指定は必須ではありません |
|
|
readonly
|
readonly | boolean |
値を上書きできるかどうか |
|
|
rememberLastValue
|
rememberLastValue | boolean |
true に設定すると、値はワークフロー間で保持されます |
戻り値
メタデータ レイアウト
- Body
- layout
メタデータ レイアウトを検索する
ワークフロー レイアウトを検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索テキスト
|
text | string |
検索テキスト |
|
|
無効を検索する
|
items.isDisabled | string |
無効なレイアウトを検索する |
|
|
検索名
|
items.name | string |
レイアウト名で検索する |
|
|
メタデータを検索する
|
items.dataConfigurations.slot | string |
メタデータの存在で検索します |
|
|
作成日付を検索する
|
items.created | string |
作成日付で検索します |
|
|
更新日を検索する
|
items.updated | string |
最終更新日で検索します |
|
|
並べ替え順
|
sortBy | string |
検索結果を並べ替えるために使用するフィールド |
|
|
並べ替え順序
|
sortOrder | string |
並べ替えの指示 |
|
|
ページあたりの項目数
|
itemsPerPage | string |
応答のページあたりの項目数 |
|
|
ページ インデックス
|
pageIndex | string |
返されるページのインデックス |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | layouts |
ワークフロー ドキュメントをダウンロードする
ワークフロー ドキュメントをダウンロードします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
ワークフローの ID |
戻り値
- 返答
- binary
ワークフローを作成する
ワークフローを作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー Id
|
userId | True | string |
ワークフロー所有者のユーザー ID |
|
Content type
|
Content-Type | string |
Content type |
|
|
件名
|
name | True | string |
ワークフローの名前 |
|
Description
|
description | string |
ワークフローの説明 |
|
|
id
|
id | string |
ステップ ID |
|
|
stepType
|
stepType | string |
署名または承認 |
|
|
consentPageId
|
consentPageId | True | string |
この受信者に関連付けられた同意ページ (署名レベル) のID |
|
メールアドレス
|
True | string |
受信者のメールアドレス |
|
|
userId
|
userId | string |
受信者をその場で作成する代わりに LE ユーザーを参照します |
|
|
phoneNumber
|
phoneNumber | string |
受信者の携帯電話番号 |
|
|
firstName
|
firstName | string |
受信者の名 |
|
|
lastName
|
lastName | string |
受信者の姓 |
|
|
国
|
country | string |
受信者の国番号 |
|
|
preferredLocale
|
preferredLocale | string |
受信者のロケール番号 |
|
|
organizationId
|
organizationId | string |
受信者の LE 組織の ID |
|
|
requiredRecipients
|
requiredRecipients | number |
次のステップに進むために署名する必要がある署名者の最小数 |
|
|
validityPeriod
|
validityPeriod | number |
ステップ有効期間 |
|
|
inviteperiod
|
inviteperiod | number |
署名リマインダーの頻度 |
|
|
maxInvites
|
maxInvites | number |
署名リマインダーの最大数 |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
署名者への署名済みドキュメントの配信を制御します |
|
|
allowComments
|
allowComments | boolean |
このステップへのコメントを許可/禁止します |
|
|
hideAttachments
|
hideAttachments | boolean |
署名者への添付ファイルの表示を制御します |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
署名者への他の署名者の表示を制御します |
|
|
イベントの通知
|
notifiedEvents | array of string |
通知されるワークフロー イベント |
|
|
userId
|
userId | string |
ウォッチャーのユーザー ID |
|
|
notifiedEvents
|
notifiedEvents | array of string |
このウォッチャーに通知されるワークフロー イベント |
|
|
メールアドレス
|
string |
ウォッチャーのメールアドレス |
||
|
Template Id
|
templateId | string |
ワークフローの派生元のテンプレートの ID |
|
|
レイアウト ID
|
layoutId | string |
ワークフローで使用されるメタデータ レイアウト |
|
|
data1
|
data1 | string |
最初のメタデータ |
|
|
data2
|
data2 | string |
2 番目のメタデータ |
|
|
data3
|
data3 | string |
3 番目のメタデータ |
|
|
data4
|
data4 | string |
4 番目のメタデータ |
|
|
data5
|
data5 | string |
5 番目のメタデータ |
|
|
data6
|
data6 | string |
6 番目のメタデータ |
|
|
data7
|
data7 | string |
7 番目のメタデータ |
|
|
data8
|
data8 | string |
最高メタデータ |
戻り値
- Body
- workflow
ワークフローを削除する
ワークフローを取得する
ワークフロー ID でワークフローを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
ワークフローの ID |
戻り値
- Body
- workflow
ワークフローを更新する
ワークフローを更新します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
更新するワークフローの ID |
|
Content type
|
Content-Type | string |
Content type |
|
|
ユーザー Id
|
userId | string |
ワークフロー所有者の ID |
|
|
件名
|
name | string |
ワークフローの名前 |
|
|
Description
|
description | string |
ワークフローの説明 |
|
|
id
|
id | string |
ステップ ID |
|
|
stepType
|
stepType | string |
署名または承認 |
|
|
consentPageId
|
consentPageId | True | string |
この受信者に関連付けられた同意ページ (署名レベル) のID |
|
メールアドレス
|
True | string |
受信者のメールアドレス |
|
|
userId
|
userId | string |
受信者をその場で作成する代わりに LE ユーザーを参照します |
|
|
phoneNumber
|
phoneNumber | string |
受信者の携帯電話番号 |
|
|
firstName
|
firstName | string |
受信者の名 |
|
|
lastName
|
lastName | string |
受信者の姓 |
|
|
国
|
country | string |
受信者の国番号 |
|
|
preferredLocale
|
preferredLocale | string |
受信者のロケール番号 |
|
|
organizationId
|
organizationId | string |
受信者の LE 組織の ID |
|
|
requiredRecipients
|
requiredRecipients | number |
次のステップに進むために署名する必要がある署名者の最小数 |
|
|
validityPeriod
|
validityPeriod | number |
ステップ有効期間 |
|
|
inviteperiod
|
inviteperiod | number |
署名リマインダーの頻度 |
|
|
maxInvites
|
maxInvites | number |
署名リマインダーの最大数 |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
署名者への署名済みドキュメントの配信を制御します |
|
|
allowComments
|
allowComments | boolean |
このステップへのコメントを許可/禁止します |
|
|
hideAttachments
|
hideAttachments | boolean |
署名者への添付ファイルの表示を制御します |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
署名者への他の署名者の表示を制御します |
|
|
イベントの通知
|
notifiedEvents | array of string |
通知されるワークフロー イベント |
|
|
userId
|
userId | string |
ウォッチャーのユーザー ID |
|
|
notifiedEvents
|
notifiedEvents | array of string |
このウォッチャーに通知されるワークフロー イベント |
|
|
メールアドレス
|
string |
メールアドレス |
||
|
ワークフローの状態
|
workflowStatus | string |
ワークフローの現在の状態 |
|
|
data1
|
data1 | string |
最初のメタデータ |
|
|
data2
|
data2 | string |
2 番目のメタデータ |
|
|
data3
|
data3 | string |
3 番目のメタデータ |
|
|
data4
|
data4 | string |
4 番目のメタデータ |
|
|
data5
|
data5 | string |
5 番目のメタデータ |
|
|
data6
|
data6 | string |
6 番目のメタデータ |
|
|
data7
|
data7 | string |
7 番目のメタデータ |
|
|
data8
|
data8 | string |
最高メタデータ |
戻り値
- Body
- workflow
ワークフローを検索する
ワークフローを検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Accept
|
Accept | string |
Accept |
|
|
検索テキスト
|
text | string |
検索テキスト |
|
|
メタデータ レイアウトを検索する
|
items.layoutId | string |
メタデータ レイアウトで検索します |
|
|
テンプレートの検索
|
items.templateId | string |
ワークフロー テンプレートで検索します |
|
|
グループを検索する
|
items.groupId | string |
ユーザーのグループで検索します |
|
|
ユーザーの検索
|
items.userId | string |
所有者で検索します |
|
|
メールアドレスを検索する
|
items.email | string |
所有者のメールアドレスで検索します |
|
|
名を検索する
|
items.firstname | string |
所有者の名で検索します |
|
|
姓を検索する
|
items.lastname | string |
所有者の姓で検索します |
|
|
検索の状態
|
items.workflowStatus | string |
ワークフローの状態で検索します |
|
|
メタデータ 1 を検索する
|
items.data1 | string |
メタデータ 1 の値で検索します |
|
|
メタデータ 2 を検索する
|
items.data2 | string |
メタデータ 2 の値で検索します |
|
|
メタデータ 3 を検索する
|
items.data3 | string |
メタデータ 3 の値で検索します |
|
|
メタデータ 4 を検索する
|
items.data4 | string |
メタデータ 4 の値で検索します |
|
|
メタデータ 5 を検索する
|
items.data5 | string |
メタデータ 5 の値で検索します |
|
|
メタデータ 6 を検索する
|
items.data6 | string |
メタデータ 6 の値で検索します |
|
|
メタデータ 7 を検索する
|
items.data7 | string |
メタデータ 7 の値で検索します |
|
|
メタデータ 8 を検索する
|
items.data8 | string |
メタデータ 8 の値で検索します |
|
|
作成日付を検索する
|
items.created | string |
作成日付で検索します |
|
|
更新日を検索する
|
items.updated | string |
最終更新日で検索します |
|
|
開始日を検索する
|
items.started | string |
開始日で検索します |
|
|
並べ替え順
|
sortBy | string |
検索結果を並べ替えるために使用するフィールド |
|
|
並べ替え順序
|
sortOrder | string |
並べ替えの指示 |
|
|
ページあたりの項目数
|
itemsPerPage | string |
応答のページあたりの項目数 |
|
|
ページ インデックス
|
pageIndex | string |
返されるページのインデックス |
戻り値
- Body
- workflows
取引先担当者の削除
現在のユーザーの取引先担当者一覧から取引先担当者を削除します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
連絡先 ID
|
contactId | True | string |
取引先担当者の ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
戻り値
- Body
- contact
取引先担当者の検索
取引先担当者の検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索テキスト
|
text | string |
テキストを検索する |
|
|
メールアドレスを検索する
|
items.email | string |
メールで検索する |
|
|
電話番号を検索する
|
items.phoneNumber | string |
電話番号で検索します |
|
|
名を検索する
|
items.fisrtName | string |
名で検索します |
|
|
姓を検索する
|
items.lastName | string |
姓で検索します |
|
|
国を検索する
|
items.country | string |
国で検索します |
|
|
ページあたりの項目数
|
itemsPerPage | number |
応答のページあたりの項目数 |
|
|
ページ インデックス
|
pageIndex | number |
返されるページのインデックス |
戻り値
- Body
- contacts
取引先担当者を取得する
取引先担当者 ID で取引先担当者情報を取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
連絡先 ID
|
contactId | True | string |
取引先担当者の ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
戻り値
- Body
- contact
同意ページ URL の取得
受信者の同意ページ URL を作成および取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ワークフロー ID
|
workflowId | True | string |
ワークフローの ID |
|
受信者のメール
|
recipientEmail | string |
該当する受信者のメールアドレス |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
該当する受信者の同意ページ URL
|
inviteUrl | string |
該当する受信者の同意ページ URL |
同意ページの取得
同意ページ ID から同意ページ情報を取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
同意ページ ID
|
cpId | True | string |
同意ページの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
戻り値
- Body
- consentPage
同意ページを検索する
同意ページを検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索テキスト
|
text | string |
検索テキスト |
|
|
既定を検索する
|
items.isDefault | string |
既定の同意ページを検索します |
|
|
無効を検索する
|
items.isDisabled | string |
無効な同意ページを検索します |
|
|
検索名
|
items.name | string |
同意ページ名で検索します |
|
|
ステップ タイプを検索する
|
items.stepType | string |
ステップ タイプで検索します |
|
|
クライアント ID を検索する
|
items.clientId | string |
クライアント ID で検索します |
|
|
作成日付を検索する
|
items.created | string |
作成日付で検索します |
|
|
更新日を検索する
|
items.updated | string |
最終更新日で検索します |
|
|
並べ替え順
|
sortBy | string |
検索結果を並べ替えるフィールド |
|
|
並べ替え順序
|
sortOrder | string |
並べ替えの指示 |
|
|
ページあたりの項目数
|
itemsPerPage | string |
応答のページあたりの項目数 |
|
|
ページ インデックス
|
pageIndex | string |
返されるページのインデックス |
戻り値
- Body
- consentPages
署名プロファイルを作成する
署名プロファイルを作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
テナント ID です
|
tenantId | True | string |
テナントの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
Is Default
|
isDefault | True | string |
この署名プロファイルを既定のプロファイルにします |
|
無効
|
isDisabled | string |
この署名プロファイルを無効にします |
|
|
件名
|
name | True | string |
署名プロファイル名 |
|
ドキュメントのタイプ
|
documentType | True | string |
PDF、XML、Word、Excel、PowerPoint、その他 |
|
署名の種類
|
signatureType | True | string |
pades、xades、xadesDetached、xadesDetachedManifest、cades、helios |
|
ドキュメントの一番下までスクロールする
|
forceScrollDocument | True | boolean |
署名者は強制的にドキュメントの一番下までスクロールされます |
|
可視署名モード
|
pdfVisibleSignatureMode | string |
可視署名モード (許可、無効、画像なし) |
|
|
署名テキスト
|
pdfSignatureImageText | string |
署名パッドに表示されるテキスト |
|
|
署名テキストの色
|
pdfSignatureImageTextColor | string |
署名パッドに表示されるテキストの色 |
|
|
署名テキストのサイズ
|
pdfSignatureImageTextSize | number |
署名パッドに表示されるテキストのサイズ |
戻り値
- Body
- signatureProfile
署名プロファイルを取得する
署名プロファイルを取得します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
署名プロファイル ID
|
spId | True | string |
署名プロファイルの ID |
戻り値
- Body
- signatureProfile
署名プロファイルを更新する
署名プロファイルを更新します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
署名プロファイル ID
|
spId | True | string |
署名プロファイルの ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
Is Default
|
isDefault | string |
この署名プロファイルを既定のプロファイルにします |
|
|
無効
|
isDisabled | string |
この署名プロファイルを無効にします |
|
|
件名
|
name | string |
署名プロファイル名 |
|
|
署名の種類
|
signatureType | string |
pades、xades、xadesDetached、xadesDetachedManifest、cades、helios |
|
|
ドキュメントの一番下までスクロールする
|
forceScrollDocument | boolean |
署名者は強制的にドキュメントの一番下までスクロールされます |
|
|
可視署名モード
|
pdfVisibleSignatureMode | string |
可視署名モード (許可、無効、画像なし) |
|
|
署名テキスト
|
pdfSignatureImageText | string |
署名パッドに表示されるテキスト |
|
|
署名テキストの色
|
pdfSignatureImageTextColor | string |
署名パッドに表示されるテキストの色 |
|
|
署名テキストのサイズ
|
pdfSignatureImageTextSize | number |
署名パッドに表示されるテキストのサイズ |
戻り値
- Body
- signatureProfile
署名プロファイルを検索する
署名プロファイルを検索する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索テキスト
|
text | string |
検索テキスト |
|
|
既定を検索する
|
items.isDefault | string |
既定の署名プロファイルを検索します |
|
|
無効を検索する
|
items.isDisabled | string |
無効な署名プロファイルを検索します |
|
|
検索名
|
items.name | string |
署名プロファイル名で検索します |
|
|
ドキュメント タイプを検索する
|
items.documentType | string |
ドキュメント タイプで検索します |
|
|
署名タイプを検索する
|
items.signatureType | string |
署名タイプで検索します |
|
|
作成日付を検索する
|
items.created | string |
作成日付で検索します |
|
|
更新日を検索する
|
items.updated | string |
最終更新日で検索します |
|
|
並べ替え順
|
sortBy | string |
検索結果を並べ替えるために使用するフィールド |
|
|
並べ替え順序
|
sortOrder | string |
並べ替えの指示 |
|
|
ページあたりの項目数
|
itemsPerPage | string |
応答のページあたりの項目数 |
|
|
ページ インデックス
|
pageIndex | string |
返されるページのインデックス |
戻り値
- Body
- signatureProfiles
自分を取得する
連絡先の作成
現在のユーザーの取引先担当者一覧に取引先担当者を追加します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー Id
|
userId | True | string |
取引先担当者が属するユーザー |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
Contact email
|
True | string |
Contact email |
|
|
取引先担当者の電話番号
|
phoneNumber | string |
phoneNumber |
|
|
取引先担当者の名
|
firstName | True | string |
firstName |
|
取引先担当者の姓
|
lastName | True | string |
lastName |
|
取引先担当者の国
|
country | string |
国 |
戻り値
- Body
- contact
連絡先の更新
既存の取引先担当者情報を更新します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
連絡先 ID
|
contactId | True | string |
取引先担当者の ID |
|
Content type
|
Content-Type | True | string |
Content-Type |
|
取引先担当者のメールアドレス
|
string |
取引先担当者のメールアドレス |
||
|
連絡先の電話番号
|
phoneNumber | string |
連絡先の電話番号 |
|
|
取引先担当者の名
|
firstName | string |
取引先担当者の名 |
|
|
取引先担当者の姓
|
lastName | string |
取引先担当者の姓 |
|
|
取引先担当者の国
|
country | string |
取引先担当者の国 |
戻り値
- Body
- contact
定義
consentPage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
組織の使用を許可します |
|
authenticateUser
|
authenticateUser | boolean |
署名者認証を課します |
|
clientId
|
clientId | string |
クライアント ID |
|
created
|
created | number |
作成日 |
|
emUrl
|
emUrl | string |
エビデンス マネージャー URL |
|
hideDownloads
|
hideDownloads | boolean |
ドキュメントのダウンロード リンクを同意ページに表示しません |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
コンテンツ ページの QR コードを非表示にします |
|
id
|
id | string |
同意ページ ID |
|
isCountryRequired
|
isCountryRequired | boolean |
署名者情報で国を必須にします |
|
isDisabled
|
isDisabled | boolean |
同意ページを無効にします |
|
logoResourceId
|
logoResourceId | string |
同意ページのロゴ リソースの ID |
|
名称
|
name | string |
同意ページ名 |
|
primaryColor
|
primaryColor | string |
同意ページのプライマリ カラー |
|
secondaryColor
|
secondaryColor | string |
同意ページのセカンダリ カラー |
|
sharedPassphrase
|
sharedPassphrase | string |
共有パスフレーズ |
|
署名モード
|
signing mode | string |
署名モード (ローカルまたはサーバー) |
|
stepType
|
stepType | string |
ステップの種類 (署名または承認) |
|
tenantId
|
tenantId | string |
テナント ID です |
|
tsaUrl
|
tsaUrl | string |
タイムスタンプ オーソリティ URL |
|
更新
|
updated | number |
最終変更日 |
|
verifyEmail
|
verifyEmail | boolean |
true に設定すると、署名者はメールで OTP を受信します |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
true に設定すると、署名者はテキスト メッセージで OTP を受信します |
consentPages
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of consentPage |
アイテム |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
連絡先
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
国
|
country | string |
取引先担当者の国 |
|
created
|
created | integer |
取引先担当者の作成日 |
|
メールアドレス
|
string |
Contact email |
|
|
firstName
|
firstName | string |
取引先担当者の firstName |
|
id
|
id | string |
取引先担当者 ID |
|
lastName
|
lastName | string |
取引先担当者の lastName |
|
名称
|
name | string |
取引先担当者名 (名 + 姓) |
|
phoneNumber
|
phoneNumber | string |
取引先担当者の電話番号 |
|
tenantId
|
tenantId | string |
テナント ID です |
|
更新
|
updated | integer |
取引先担当者の最終変更日 |
|
userId
|
userId | string |
取引先担当者所有者の ID |
contacts
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of contact |
アイテム |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
dataMapping
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
description
|
data1.description | string |
メタデータの記述 |
|
名称
|
data1.name | string |
メタデータ名 |
|
パターン
|
data1.pattern | string |
メタデータ パターン |
|
options
|
data1.options | array of object |
options |
|
価値
|
data1.options.value | string |
メタデータ値 |
|
タイプ
|
data1.type | string |
タイプ |
|
description
|
data2.description | string |
メタデータの記述 |
|
名称
|
data2.name | string |
メタデータ名 |
|
パターン
|
data2.pattern | string |
メタデータ パターン |
|
options
|
data2.options | array of object |
options |
|
価値
|
data2.options.value | string |
メタデータ値 |
|
タイプ
|
data2.type | string |
タイプ |
|
description
|
data3.description | string |
メタデータの記述 |
|
名称
|
data3.name | string |
メタデータ名 |
|
パターン
|
data3.pattern | string |
メタデータ パターン |
|
options
|
data3.options | array of object |
options |
|
価値
|
data3.options.value | string |
メタデータ値 |
|
タイプ
|
data3.type | string |
タイプ |
|
description
|
data4.description | string |
メタデータの記述 |
|
名称
|
data4.name | string |
メタデータ名 |
|
パターン
|
data4.pattern | string |
メタデータ パターン |
|
options
|
data4.options | array of object |
options |
|
価値
|
data4.options.value | string |
メタデータ値 |
|
タイプ
|
data4.type | string |
タイプ |
|
description
|
data5.description | string |
メタデータの記述 |
|
名称
|
data5.name | string |
メタデータ名 |
|
パターン
|
data5.pattern | string |
メタデータ パターン |
|
options
|
data5.options | array of object |
options |
|
価値
|
data5.options.value | string |
メタデータ値 |
|
タイプ
|
data5.type | string |
タイプ |
|
description
|
data6.description | string |
メタデータの記述 |
|
名称
|
data6.name | string |
メタデータ名 |
|
パターン
|
data6.pattern | string |
メタデータ パターン |
|
options
|
data6.options | array of object |
options |
|
価値
|
data6.options.value | string |
メタデータ値 |
|
タイプ
|
data6.type | string |
タイプ |
|
description
|
data7.description | string |
メタデータの記述 |
|
名称
|
data7.name | string |
Metadataname |
|
パターン
|
data7.pattern | string |
メタデータ パターン |
|
options
|
data7.options | array of object |
options |
|
価値
|
data7.options.value | string |
Metadatavalue |
|
タイプ
|
data7.type | string |
タイプ |
|
description
|
data8.description | string |
メタデータの記述 |
|
名称
|
data8.name | string |
メタデータ名 |
|
パターン
|
data8.pattern | string |
メタデータ パターン |
|
options
|
data8.options | array of object |
options |
|
価値
|
data8.options.value | string |
メタデータ値 |
|
タイプ
|
data8.type | string |
タイプ |
document
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
created
|
created | integer |
作成日 |
|
groupId
|
groupId | string |
ドキュメント所有者のグループの ID |
|
id
|
id | string |
ドキュメントの ID |
|
パーツ
|
parts | array of part |
パーツ |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
ドキュメントの署名プロファイルの ID |
|
tenantId
|
tenantId | string |
テナント ID |
|
更新
|
updated | integer |
最終変更日 |
|
userId
|
userId | string |
ドキュメント所有者のユーザー ID |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
ドキュメントの表示が許可されているグループのリスト |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
ドキュメントの表示が許可されているユーザーのリスト |
|
workflowId
|
workflowId | string |
ドキュメントが属するワークフローの ID |
|
workflowName
|
workflowName | string |
ドキュメントが属するワークフローの名前 |
documents
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of document |
アイテム |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
レイアウト
メタデータ レイアウト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
created
|
created | number |
作成日 |
|
id
|
id | string |
レイアウト ID |
|
isDisabled
|
isDisabled | boolean |
レイアウトが無効になっている場合は、true に設定します |
|
名称
|
name | string |
レイアウトの名前 |
|
tenantId
|
tenantId | string |
テナントの ID |
|
更新
|
updated | number |
最終変更日 |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
時間帯
|
dataConfigurations.slot | string |
メタデータ項目 (data1 から data8) |
|
default
|
dataConfigurations.default | string |
このレイアウトのメタデータの既定値 |
|
オプション
|
dataConfigurations.optional | boolean |
true の場合、このメタデータ値の指定は必須ではありません |
|
readonly
|
dataConfigurations.readonly | boolean |
値を上書きできるかどうか |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
true に設定すると、値はワークフロー間で保持されます |
レイアウト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of object | |
|
created
|
items.created | number |
作成日 |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
ページあたりの項目数 |
|
pageIndex
|
pageIndex | number |
返されるページのインデックス |
|
totalItems
|
totalItems | number |
要求に関連する項目の合計数 |
パーツ
ドキュメント パーツ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
contentType
|
contentType | string |
contentType |
|
ファイル名
|
filename | string |
ファイル名 |
|
ハッシュ
|
hash | string |
ハッシュ |
|
size
|
size | integer |
size |
pdfSigField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
created
|
created | number |
作成日 |
|
documentType
|
documentType | string |
ドキュメントの種類 |
|
forceScrollDocument
|
forceScrollDocument | boolean |
署名者は強制的にドキュメントの一番下までスクロールされます |
|
id
|
id | string |
署名プロファイル ID |
|
isDefault
|
isDefault | boolean |
この署名プロファイルを既定のプロファイルにします |
|
isDisabled
|
isDisabled | boolean |
この署名プロファイルを無効にします |
|
名称
|
name | string |
署名プロファイル名 |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
署名パッドに表示されるテキスト |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
署名パッドに表示されるテキストの色 |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
署名パッドに表示されるテキストのサイズ |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
可視署名モード (許可、無効、画像なし) |
|
署名の種類
|
signatureType | string |
pades、xades、xadesDetached、xadesDetachedManifest、cades、helios |
|
tenantId
|
tenantId | string |
テナント ID です |
|
更新
|
updated | number |
最終変更日 |
signatureProfiles
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
ページあたりの項目数 |
|
pageIndex
|
pageIndex | number |
返されるページのインデックス |
|
totalItems
|
totalItems | number |
要求に関連する項目の合計数 |
user
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
true に設定すると、ユーザーはドキュメントを承認できます |
|
国
|
country | string |
ユーザーの国 |
|
created
|
created | integer |
作成日 |
|
メールアドレス
|
string |
ユーザーのメールアドレス |
|
|
firstName
|
firstName | string |
ユーザーの FirstName |
|
groupId
|
groupId | string |
ユーザーのグループの ID |
|
id
|
id | string |
ユーザーの ID |
|
isDisabled
|
isDisabled | boolean |
ユーザーが無効の場合は True |
|
lastLogin
|
lastLogin | integer |
ユーザーの前回ログイン日 |
|
lastName
|
lastName | string |
ユーザーの LastName |
|
名称
|
name | string |
ユーザーの名前 (名 + 姓) |
|
organizationTitles
|
organizationTitles | array of |
ユーザーの組織内での役職 |
|
phoneNumber
|
phoneNumber | string |
ユーザーの電話番号です |
|
signAllowed
|
signAllowed | boolean |
true に設定すると、ユーザーはドキュメントに署名できます |
|
subject
|
subject | string |
ユーザーの内部件名コード |
|
tenantId
|
tenantId | string |
テナントの ID |
|
更新
|
updated | integer |
最終変更日 |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
ユーザーがオブザーバーとして行動できるグループのリスト |
ワークフロー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
created
|
created | integer |
created |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
メタデータ 1 |
|
data2
|
data2 | string |
メタデータ 2 |
|
data3
|
data3 | string |
メタデータ 3 |
|
data4
|
data4 | string |
メタデータ 4 |
|
data5
|
data5 | string |
メタデータ 5 |
|
data6
|
data6 | string |
メタデータ 6 |
|
data7
|
data7 | string |
メタデータ 7 |
|
data8
|
data8 | string |
メタデータ 8 |
|
description
|
description | string |
ワークフローの説明 |
|
メールアドレス
|
string |
ワークフロー所有者のメールアドレス |
|
|
firstName
|
firstName | string |
ワークフロー所有者の名 |
|
groupId
|
groupId | string |
ワークフロー所有者のグループの ID |
|
id
|
id | string |
ワークフローの ID |
|
lastName
|
lastName | string |
ワークフローの所有者の姓 |
|
layoutId
|
layoutId | string |
ワークフローのメタデータ レイアウトの ID |
|
ログ
|
logs | array of |
ワークフローのログ項目 |
|
名称
|
name | string |
ワークフロー所有者の名前 (名 + 姓) |
|
notifiedEvents
|
notifiedEvents | array of string |
ワークフローによって通知されるイベントの一覧 |
|
進行状況
|
progress | integer |
ワークフローの進行状況 (パーセント) |
|
手順
|
steps | array of object |
手順 |
|
allowComments
|
steps.allowComments | boolean |
ステップで許可される対話型コメントを許可/禁止します |
|
hideAttachments
|
steps.hideAttachments | boolean |
署名者への添付ファイルの表示を制御します |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
署名者への他の署名者の表示を制御します |
|
id
|
steps.id | string |
ステップ ID |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
isStarted
|
steps.isStarted | boolean |
isStarted |
|
ログ
|
steps.logs | array of |
ログ |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
国
|
steps.recipients.country | string |
国 |
|
メールアドレス
|
steps.recipients.email | string |
メールアドレス |
|
firstName
|
steps.recipients.firstName | string |
firstName |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
phoneNumber
|
steps.recipients.phoneNumber | string |
phoneNumber |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
更新
|
updated | integer |
更新 |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
ユーザーがオブザーバーとして行動できるグループのリスト |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
ウォッチャー
|
watchers | array of object |
ウォッチャー |
|
メールアドレス
|
watchers.email | string |
メールアドレス |
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of workflow |
アイテム |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
binary
これは基本的なデータ型 'バイナリ' です。