Roostify Connector リファレンス
Roostify Connector v1.0
Roostify 用 Anypoint Connector (Roostify Connector) により、顧客は完成したローンアプリケーションから、DBA、支店、またはチャネルに合わせて最適化された、直感的なデジタルユーザーエクスペリエンスを生み出すことができます。
拡張機能のメインクラスであり、設定、接続プロバイダー、操作、およびソースを宣言するエントリポイントです。
リリースノート: Roostify Connector リリースノート
設定
デフォルト設定
デフォルト設定
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Name (名前) |
String (文字列) |
この設定の名前。コネクタはこの名前の設定を参照します。 |
x |
|
Connection (接続) |
この設定に指定する接続型。 |
x |
||
Address (住所) |
String (文字列) |
x |
||
バージョン |
String (文字列) |
x |
||
Expiration Policy (有効期限ポリシー) |
動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。 |
接続種別
Connection (接続)
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Username (ユーザー名) |
String (文字列) |
x |
||
Password (パスワード) |
String (文字列) |
x |
||
Proxy Configuration (プロキシ設定) |
||||
Use Persistent Connections (永続接続を使用) |
Boolean (ブール) |
true |
||
Max Connections (最大接続数) |
Number (数値) |
-1 |
||
Connection Idle Timeout (接続アイドルタイムアウト) |
Number (数値) |
60000 |
||
Stream Response (応答のストリーミング) |
Boolean (ブール) |
false |
||
Response Buffer Size (応答バッファサイズ) |
Number (数値) |
-1 |
||
Connection Timeout (接続タイムアウト) |
Number (数値) |
60000 |
||
TLS Configuration (TLS 設定) |
||||
Reconnection (再接続) |
アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。 |
操作
Activate a User
<roostify:activate-user>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
ユーザー ID (必須)。 |
x |
|
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Output Encoding (出力エンコード) |
String (文字列) |
この操作で出力されるペイロードのエンコード。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Deactivate a User
<roostify:cancel-order>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
ユーザー ID (必須)。 |
x |
|
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Output Encoding (出力エンコード) |
String (文字列) |
この操作で出力されるペイロードのエンコード。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create an Access Control Group
<roostify:create-access-control>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Access Control (アクセスコントロール) |
Object (オブジェクト) |
アクセスコントロールリクエストボディ作成します。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create or Update a Reference ID
<roostify:create-update-reference-id>
参照 ID により、ユーザーは外部サービスやインテグレーションを操作できます。このルートを使用することで、参照 ID が作成または更新されます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Loan_id |
String (文字列) |
更新するローンアプリケーションの ID。 |
x |
|
Reference Body (参照本文) |
Object (オブジェクト) |
ローンを更新するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a User
<roostify:create-user>
ユーザーを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
User Body (ユーザー本文) |
Object (オブジェクト) |
Roostify ユーザー作成リクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Upload or Create a Document
<roostify:creating-document>
ドキュメントをアップロードするには、ドキュメントを JSON として /documents に投稿します。ペイロード本文中の file_content は、base64 でエンコードされたドキュメントのデータです。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Document (ドキュメント) |
Object (オブジェクト) |
ドキュメントを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Task from a File Content Task
<roostify:creating-file-content-task>
ファイルコンテンツタスクからタスクを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
File Content Task (ファイルコンテンツタスク) |
Object (オブジェクト) |
ファイルコンテンツタスクからタスクを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Lead
<roostify:creating-lead>
リードエンドポイントは、Roostify でリードを作成するためのパラメーターを受け入れます。各パラメーターを許可リストに登録しておかないと、システムでは受け入れられません。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Create Lead (リードの作成) |
Object (オブジェクト) |
リードを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Loan Application
<roostify:creating-loan-application>
ローンアプリケーションの作成は、サービスごとに許可する必要があります。デフォルトではアクセスは拒否されます。ローンアプリケーションは、上記のすべての属性を API へのパラメーターとして渡すことで作成できます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Create Loan Request (ローン要求の作成) |
Object (オブジェクト) |
ローンリクエストボディを作成します。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Message
<roostify:creating-message>
アカウントのメールと名前を入力すると、このエンドポイントから作成される送信元アドレスは、そのアカウント名とメールアドレスを使用します。これらを入力しないと、no-reply@deliver.roostify.com のようなアドレスからメールが送信されます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Message (メッセージ) |
Object (オブジェクト) |
メッセージを作成するためのメッセージリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Task from a Regular Task
<roostify:creating-regular-task>
通常のタスクからタスクを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Regular Task (通常タスク) |
Object (オブジェクト) |
通常のタスクからタスクを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Task from a Speed-bump Task
<roostify:creating-speed-bump-task>
スピードバンプタスクからタスクを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Speed Bump Task (スピードバンプタスク) |
Object (オブジェクト) |
スピードバンプタスクからタスクを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Status Update
<roostify:creating-status-update>
状況の更新は、コラボレーターがローンアプリケーションへの更新を監視するために使用するストリーム内で発生します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Status (状況) |
Object (オブジェクト) |
状況の更新を作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Task from an Approval Task
<roostify:creating-task-from-approval>
承認タスクから新しいタスクを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Approval Task (承認タスク) |
Object (オブジェクト) |
承認タスクからタスクを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Task from a Form Task
<roostify:creating-task-from-form>
フォームタスクから新しいタスクを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Form Task (フォームタスク) |
Object (オブジェクト) |
フォームタスクからタスクを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Task from a View-only Task
<roostify:creating-view-only-task>
表示専用タスクからタスクを作成します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
View Only Task (表示専用タスク) |
Object (オブジェクト) |
表示専用タスクからタスクを作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Create a Webhook
<roostify:creating-webhook>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Webhook Body (Web ブック本文) |
Object (オブジェクト) |
Web フック作成するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Delete a Webhook
<roostify:deleting-webhook>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Webhook Id (Web フック ID) |
String (文字列) |
破棄する Web フックの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Download a Document
<roostify:downloading-document>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
必須。取得するドキュメントの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Lead
<roostify:get-lead>
リードエンドポイントは、Roostify でリードを作成するためのパラメーターを受け入れます。各パラメーターを許可リストに登録しておかないと、システムでは受け入れられません。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Lead Id (リード ID) |
String (文字列) |
リードの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
List Messages
<roostify:get-messages>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
List Accounts
<roostify:listing-accounts>
すべてのアカウントのリストを取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Page (ページ) |
String (文字列) |
返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
List Documents
<roostify:listing-documents>
ドキュメントのメタデータを取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Page (ページ) |
String (文字列) |
返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Filter (検索条件) |
String (文字列) |
reference_id の有無によってドキュメントのメタデータを絞り込むための単語。 |
||
Search (検索) |
String (文字列) |
ドキュメントのメタデータを検索するための単語。現時点で検索できる単語は、document_name、loan_application_reference_id、loan_application_id です。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
List Loan Applications
<roostify:listing-loan-applications>
アカウントまたはその子孫に属するすべてのローンアプリケーションのリストを取得します。大量のローンアプリケーションを持つクライアントの場合は、ページネーションを使用しないとタイムアウトになる場合があります。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Search (検索) |
String (文字列) |
指定された属性と一致するローンアプリケーションのみをリストします。パラメーター構造は search[attribute]=… です。 |
||
Page (ページ) |
String (文字列) |
返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Created (作成済み) |
String (文字列) |
ローンアプリケーションが作成された日付に基づいてローンアプリケーションを絞り込みます。文字列は、「…」で区切られた 2 つの ISO-8601 日付スタンプの形式でなければなりません。タイムゾーン指定子を省略した場合はデフォルトの UTC となります。 |
||
Submitted (送信済み) |
String (文字列) |
ローンアプリケーションが送信された日付に基づいてローンアプリケーションを絞り込みます。文字列は、「…」で区切られた 2 つの ISO-8601 日付スタンプの形式でなければなりません。タイムゾーン指定子を省略した場合はデフォルトの UTC となります。 |
||
Updated (更新済み) |
String (文字列) |
ローンアプリケーションが更新された日付に基づいてローンアプリケーションを絞り込みます。文字列は、「…」で区切られた 2 つの ISO-8601 日付スタンプの形式でなければなりません。タイムゾーン指定子を省略した場合はデフォルトの UTC となります。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Listing Tasks
<roostify:listing-tasks>
すべてのタスクとそれぞれの詳細のリストを返します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Loan_application_id |
String (文字列) |
関連付けられているタスクを検索するローンアプリケーション ID。 |
||
Page (ページ) |
String (文字列) |
返されるページ番号を示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
List Users
<roostify:listing-users>
すべてのユーザーとそれぞれの詳細のリストを返します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Page (ページ) |
String (文字列) |
返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Search (検索) |
String (文字列) |
指定された属性と一致するユーザーのみをリストします。パラメーター構造は search[attribute]=… です。URL エンコードされた検索パラメーターのハッシュを取ります。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Listing Webhook Events
<roostify:listing-webhook-events>
Web フックイベントは、特定のイベントに対して Web フックが実行されたすべてのインスタンスを記録し、Web フックで追跡可能なすべてのイベントの監査ログとして使用できます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Page (ページ) |
String (文字列) |
返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Created (作成済み) |
String (文字列) |
ISO 8601 DateTime range (ISO 8601 日時範囲)。返された結果を、この日付範囲内に作成された Web フックイベントのみに絞り込みます。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
List Webhooks
<roostify:listing-webhooks>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Page (ページ) |
String (文字列) |
返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Count (数) |
String (文字列) |
返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Loan Application by Reference ID
<roostify:loan-application-by-reference-id>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Reference Id (参照 ID) |
String (文字列) |
取得するローンアプリケーションの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Loan Application in FNM Format
<roostify:loan-applications-fnm>
ほとんどの API とは異なり、ローンアプリケーション FNM エンドポイントは、JSON ではなくプレーンテキストを返します。返される文字列は、Base64 でエンコードされた Fannie Mae (連邦住宅抵当公庫) ファイルです。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
取得するローンアプリケーションの ID。 |
x |
|
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Output Encoding (出力エンコード) |
String (文字列) |
この操作で出力されるペイロードのエンコード。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Loan Application
<roostify:loan-applications-id>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Find_id |
String (文字列) |
取得するローンアプリケーションの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Loan Application in MISMO Format
<roostify:loan-applications-mismo>
ローンアプリケーションを MISMO 形式でダウンロードするには、パートナーまたはクライアントのサクセスマネージャーからの要求が必要です。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
取得するローンアプリケーションの ID。 |
x |
|
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Output Encoding (出力エンコード) |
String (文字列) |
この操作で出力されるペイロードのエンコード。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Service
<roostify:retrieve-your-service>
Roostify でビルドされたアプリケーションは、特定のユーザーやアカウントに紐付けられた設定または他の種類のデータを必要とすることがあります。たとえば、Roostify からローン組成システムに対してローンアプリケーションを同期させる製品をビルドする場合、融資会社を適切に割り当てることができるように、融資会社に対してローン組成システムのユーザー名を入力するように求めることが考えられます。これらはユーザー設定と見なされます。アカウント設定は、同じアカウントのユーザーグループで共有されるデータに適用されます。融資会社とアカウント管理者は、Roostify UI でこれらの設定の値を定義できます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Task
<roostify:retrieving-a-task>
単一タスクの詳細を取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Task Id (タスク ID) |
String (文字列) |
タスクの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve an Account
<roostify:retrieving-account>
Roostify ユーザーはいずれかのアカウントのメンバーとなります。請求、権限、サービスインテグレーション、アプリケーションとワークフローのカスタマイズ、共同ブランディングスタイルなどは、アカウント単位で管理されます。 サービスに統合されているアカウントであれば、その基本情報にアクセスできます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
アカウントの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Document Metadata
<roostify:retrieving-document>
ドキュメントのメタデータを取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Find_id |
String (文字列) |
取得するドキュメントの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Message
<roostify:retrieving-message>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Message Id (メッセージ ID) |
String (文字列) |
取得するメッセージの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve an Integration Service
<roostify:retrieving-settings>
Roostify サービスは、アカウントレベルでカスタマイズできます。/settings エンドポイントを使用して、サービスの設定にアクセスできます。これらはキー/値ペアとして返されます。たとえば、Roostify が設定を必要とするインテグレーションを利用している場合、この GET 要求によって、設定の項目と値、そしてアカウントに関連付けられている融資会社が返されます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a User
<roostify:retrieving-user>
単一ユーザーの詳細を取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
User Id (ユーザー ID) |
String (文字列) |
ユーザーの ID |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a Webhook
<roostify:retrieving-webhook>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Webhook Id (Web フック ID) |
String (文字列) |
取得する Web フックの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Update an Access Control Group
<roostify:update-access-control>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Access Control Group (アクセスコントロールグループ) |
Object (オブジェクト) |
アクセスコントロール更新リクエストボディ。 |
|
|
Id |
String (文字列) |
タスクの ID またはシステム名。指定した文字列と一致する ID を検索しても結果が返されない場合は、システム名での検索が試みられます。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Update a Document Metadata
<roostify:update-document>
ドキュメントのメタデータを更新して、ドキュメントのメタデータを返します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Document Body (ドキュメント本文) |
Object (オブジェクト) |
ドキュメントを更新するためリクエストボディ。 |
|
|
Id |
String (文字列) |
更新するドキュメントの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Update a Task
<roostify:update-task>
単一タスクの詳細を取得します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Task Body (タスク本文) |
Object (オブジェクト) |
タスクを更新するためのリクエストボディ。 |
|
|
Task Id (タスク ID) |
String (文字列) |
タスクの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Update a User
<roostify:update-user>
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
ユーザー |
Object (オブジェクト) |
ユーザーを更新するためのリクエストボディ。 |
|
|
Id |
String (文字列) |
ユーザー ID。 |
x |
|
Output Mime Type (出力 MIME タイプ) |
String (文字列) |
この操作で出力されるペイロードの MIME タイプ。 |
||
Output Encoding (出力エンコード) |
String (文字列) |
この操作で出力されるペイロードのエンコード。 |
||
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Update a Loan Application
<roostify:updating-loan-application>
ローンアプリケーションの更新は、サービスごとに許可する必要があります。デフォルトではアクセスは拒否されます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Update_id |
String (文字列) |
更新するローンアプリケーションの ID。 |
x |
|
Update Loan Request (ローン更新要求) |
Object (オブジェクト) |
ローンアプリケーションを更新するためのリクエストボディ。 |
|
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
Retrieve a User Settings
<roostify:user-settings>
特定のユーザーの設定を取得すると、そのユーザーが属するアカウントの設定も返されます。特定のユーザーに関するすべての設定を単一の要求で取得できるため、操作が簡素化されます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Id |
String (文字列) |
設定を取得するユーザーの ID。 |
x |
|
Streaming Strategy (ストリーミング戦略) |
|
反復可能なストリームを使用するように設定します。 |
||
Target Variable (対象変数) |
String (文字列) |
操作の出力を保存する変数の名前。 |
||
Target Value (対象値) |
String (文字列) |
操作の出力に対して評価される式。この式の結果が対象変数に保存されます。 |
|
|
Reconnection Strategy (再接続戦略) |
接続エラーが発生した場合の再試行戦略。 |
スロー
-
ROOSTIFY:BAD_GATEWAY
-
ROOSTIFY:INTERNAL_SERVER_ERROR
-
ROOSTIFY:METHOD_NOT_ALLOWED
-
ROOSTIFY:UN_PROCESSABLE_ENTITY
-
ROOSTIFY:NOT_IMPLEMENTED
-
ROOSTIFY:CONNECTIVITY
-
ROOSTIFY:GENERIC_EXCEPTION
-
ROOSTIFY:NOT_ACCEPTABLE
-
ROOSTIFY:NOT_FOUND
-
ROOSTIFY:SERVICE_UNAVAILABLE
-
ROOSTIFY:RETRY_EXHAUSTED
-
ROOSTIFY:UNAUTHORIZED
-
ROOSTIFY:FORBIDDEN
-
ROOSTIFY:EMPTY_HEAD_COUNT
-
ROOSTIFY:CONFLICT
-
ROOSTIFY:BAD_REQUEST
-
ROOSTIFY:DEAD_TOKEN
-
ROOSTIFY:REQUEST_TIMEOUT
型
Default (デフォルト)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Host (ホスト) |
String (文字列) |
プロキシ要求が送信されるホスト。 |
x |
|
Port (ポート) |
Number (数値) |
プロキシ要求が送信されるポート。 |
x |
|
Username (ユーザー名) |
String (文字列) |
プロキシに対して認証するユーザー名。 |
||
Password (パスワード) |
String (文字列) |
プロキシに対して認証するパスワード。 |
||
Non Proxy Hosts (非プロキシホスト) |
String (文字列) |
プロキシの使用対象にならないカンマ区切りホストのリスト。 |
TLS
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Enabled Protocols (有効化されたプロトコル) |
String (文字列) |
このコンテキストで有効化されたプロトコルのカンマ区切りリスト。 |
||
Enabled Cipher Suites (有効化された暗号化スイート) |
String (文字列) |
このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。 |
||
Trust Store (トラストストア) |
||||
Key Store (キーストア) |
||||
Revocation Check (取り消し確認) |
トラストストア
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Path (パス) |
String (文字列) |
トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。 |
||
Password (パスワード) |
String (文字列) |
トラストストアを保護するために使用するパスワード。 |
||
Type (型) |
String (文字列) |
使用するストアの型。 |
||
Algorithm (アルゴリズム) |
String (文字列) |
トラストストアで使用するアルゴリズム。 |
||
Insecure (安全ではない) |
Boolean (ブール) |
true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。 |
Key Store (キーストア)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Path (パス) |
String (文字列) |
キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。 |
||
Type (型) |
String (文字列) |
使用するストアの型。 |
||
Alias (別名) |
String (文字列) |
キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。 |
||
Key Password (キーパスワード) |
String (文字列) |
非公開キーを保護するために使用するパスワード。 |
||
Password (パスワード) |
String (文字列) |
キーストアを保護するために使用するパスワード。 |
||
Algorithm (アルゴリズム) |
String (文字列) |
キーストアで使用するアルゴリズム。 |
Standard Revocation Check (標準の取り消し確認)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Only End Entities (最後のエンティティのみ) |
Boolean (ブール) |
証明書チェーンの最後の要素のみを確認します。 |
||
Prefer CRLs (CRL を優先) |
Boolean (ブール) |
最初に OCSP ではなく CRL を試みます。 |
||
No Fallback (代替なし) |
Boolean (ブール) |
第 2 の確認方法 (以前に選択されていない方法) を使用しません。 |
||
Soft Fail (ソフトフェール) |
Boolean (ブール) |
取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。 |
Custom OCSP Responder (カスタム OCSP レスポンダー)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Url |
String (文字列) |
OCSP レスポンダーの URL。 |
||
Cert Alias (証明書の別名) |
String (文字列) |
(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。 |
Reconnection (再接続)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Fails Deployment (デプロイメントに失敗) |
Boolean (ブール) |
アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。 |
||
Reconnection Strategy (再接続戦略) |
使用する再接続戦略。 |
Reconnect (再接続)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Frequency (頻度) |
Number (数値) |
再接続する頻度 (ミリ秒)。 |
||
Count (数) |
Number (数値) |
再接続の試行回数。 |
||
blocking (ブロック) |
Boolean (ブール) |
false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。 |
true |
Reconnect Forever (繰り返し再接続)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Frequency (頻度) |
Number (数値) |
再接続する頻度 (ミリ秒)。 |
||
blocking (ブロック) |
Boolean (ブール) |
false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。 |
true |
Expiration Policy (有効期限ポリシー)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Max Idle Time (最大アイドル時間) |
Number (数値) |
有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値 |
||
Time Unit (時間単位) |
Enumeration (列挙)。次のいずれかになります。
|
maxIdleTime 属性の時間単位 |
Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Initial Buffer Size (初期バッファサイズ) |
Number (数値) |
ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。 |
||
Buffer Size Increment (バッファサイズ増分) |
Number (数値) |
バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。 |
||
Max Buffer Size (最大バッファサイズ) |
Number (数値) |
使用するメモリの最大量。これを超えると、STREAM_MAXIMUM_SIZE_EXCEEDED エラーが発生します。0 以下の値は無制限を意味します。 |
||
Buffer Unit (バッファ単位) |
Enumeration (列挙)。次のいずれかになります。
|
これらのすべての属性の単位 |