# mulesoft Roostify Connector - Full Documentation

<!-- document id=10a99b487681c5a5a6f1a1fedcab66cf083965b111bc3ca2ecf46b77028796b8 url=/mulesoft/current/ja-jp/roostify-connector/latest/index.md -->

# Roostify Connector

Roostify Connector v1.0

Roostify 用 Anypoint Connector (Roostify Connector) により、顧客は完成したローンアプリケーションから、DBA、支店、またはチャネルに合わせて最適化された、直感的なデジタルユーザーエクスペリエンスを生み出すことができます。これによってローンの実行率が向上し、ビジネス要件に拡張に合わせた柔軟性と拡張性の高いフレームワークが提供されます。Roostify の統合プラットフォームは、ローン契約を迅速化し、ローン会社が顧客の開拓と管理を同時に行えるようにします。この結果、収益性に加えて、顧客の定着率や紹介率も高まります。

Roostify Connector は、Roostify の 46 の API へのアクセスを簡素化し、以下に関連するワークフローをサポートします。

- Access Control (アクセスコントロール)
- アカウント
- Desktop Underwriter レポート
- Documents (ドキュメント)
- リード (ドラフト)
- ローンアプリケーション
- Messages
- 商品 (ドラフト)
- 参照 ID
- API を使用した
- 設定
- 状態変更
- 状況更新
- タスク
- ユーザー管理
- ユーザー設定
- Web フックイベント
- Web フック

リリースノート: [Roostify Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/roostify-connector-release-notes-mule-4)​  
Exchange: [Roostify Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-roostify-connector/)

## [](#始める前に)始める前に

この情報を使用するには、Roostify、Mule の概念、Anypoint Connector、Anypoint Studio、Mule フローの要素、グローバル要素に精通している必要があります。

API は、ユーザー名とパスワードに基づく基本認証を使用します。コネクタを使用するには、Roostify のアカウントとログイン情報が必要です。ユーザー名はアカウントトークン、パスワードはサービスアクセストークンとして機能します。ユーザー名とパスワードは、認証ヘッダー内の Basic という単語に続いて base64 でエンコードされた文字列として格納され、​`account-token:service-access-token`​ の形式でデコードされます。

ソフトウェアの要件および互換性については、「コネクタリリースノート」を参照してください。

## [](#pom-ファイル情報)POM ファイル情報

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-roostify-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

`x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。

最新の ​`pom.xml`​ ファイル情報を取得するには、​ [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ でコネクタにアクセスし、​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。

## [](#studio-プロジェクトへのコネクタの追加)Studio プロジェクトへのコネクタの追加

Anypoint Studio には、Studio プロジェクトにコネクタを追加する 2 つの方法があります。Studio タスクバーの Exchange ボタンから追加するか、\[Mule Palette (Mule パレット)\] ビューから追加します。

### [](#exchange-を使用してコネクタを追加する)Exchange を使用してコネクタを追加する

1. Studio で Mule プロジェクトを作成します。
2. Studio タスクバーの左上にある Exchange アイコン ​**(X)**​ をクリックします。
3. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。
4. Exchange で、「roostify」を検索します。
5. コネクタを選択して ​**\[Add to project (プロジェクトに追加)\]**​ をクリックします。
6. 画面の指示に従ってコネクタをインストールします。

### [](#studio-でコネクタに追加する)Studio でコネクタに追加する

1. Studio で Mule プロジェクトを作成します。
2. \[Mule Palette (Mule パレット)\] ビューで、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。
3. **\[Add Modules to Project (モジュールをプロジェクトに追加)\]**​ で、検索項目に「roostify」と入力します。
4. **\[Available modules (使用可能なモジュール)\]**​ で、このコネクタの名前をクリックします。
5. **\[Add (追加)\]**​ をクリックします。
6. **\[Finish (完了)\]**​ をクリックします。

## [](#コネクタの名前空間とスキーマ)コネクタの名前空間とスキーマ

Anypoint Studio でアプリケーションデザインするときに、パレットのコネクタをキャンバスにドラッグします。 このアクションにより、自動的に XML コードにコネクタの名前空間およびスキーマの場所が入力されます。

- 名前空間: `http://www.mulesoft.org/schema/mule/roostify`
- スキーマの場所: `http://www.mulesoft.org/schema/mule/roostify/current/mule-roostify.xsd`

## [](#anypoint-studio-で-roostify-connector-を設定する)Anypoint Studio で Roostify Connector を設定する

1. Anypoint Studio で、新しい Mule プロジェクトを作成します。​**HTTP リスナー**​が設定されていることを確認します。
2. コネクタを Studio キャンバスにドラッグします。
3. コネクタのグローバル要素を設定します。ログイン情報をグローバル設定プロパティとして入力するか、それらの値を含む設定ファイルを参照することができます。 メンテナンスをシンプルにして、プロジェクトを再利用できるようにするために、設定ファイルを使用することをお勧めします。
    
    - **Address (アドレス)**​: Roostify API にアクセスするための URI
    - **Username (ユーザー名)**​: Roostify API にアクセスするためのユーザー名
    - **Password (パスワード)**​: Roostify API にアクセスするためのパスワード
    - **Version (バージョン)**​: Roostify API バージョン。たとえば、API バージョンが ​`v1`​ であれば、このプロパティの値は ​`/v1`​ でなければなりません。
        
        <table><tbody><tr><td class="icon"><i class="fa icon-tip" title="Tip"></i></td><td class="content">Roostify のサンプル設定ファイルは ​<code>src/main/resources/configuration.yaml</code>​ にあります。このファイルは、[Global Configuration Elements (グローバル設定要素)] の [Configuration Properties (設定プロパティ)] に追加できます。</td></tr></tbody></table>
4. 接続が成功することを確認するには、​**\[Test Connection (接続をテスト)\]**​ をクリックします。
5. コネクタ操作を選択します。

## [](#ユースケース-roostify-ユーザーとローンアプリケーションの作成)ユースケース: Roostify ユーザーとローンアプリケーションの作成

以下のユースケースでは、Roostify Connector を Salesforce Connector と一緒に使用することで、次の作業を行います。

- Roostify で Salesforce アカウント用のユーザーを作成する
- Roostify で同じユーザー用のローンアプリケーションを作成する

この例では、Mule アプリケーションが Salesforce アカウントに対してクエリを実行し、このアカウント用のユーザーを Roostify で作成します。フローの次のステップでは、この新しいユーザー用のローンアプリケーションを Roostify で作成します。

![ユーザーとローンアプリケーションの作成フロー](/mulesoft/current/ja-jp/roostify-connector/latest/_images/roostify-create-loan-application.png)

このユースケースをテストする手順は、次のとおりです。

1. Mule アプリケーションを作成し、​`src/main/resources`​ の設定ファイルでコネクタ設定プロパティを設定します。次に例を示します。
    
    ```yaml
    rsf:
      address: "<url-to-access-roostify-api>"
      version: "/<roostify-api-version>"
      user: "<username-to-access-roostify-api>"
      password: "<password-to-access-roostify-api>"
    ```
2. Roostify Connector 用の設定ファイルを ​**\[Global Element Properties (グローバル要素のプロパティ)\]**​ の ​**\[Configuration Properties (設定プロパティ)\]**​ に追加します。

新しい Mule アプリケーションフローを作成する手順は、次のとおりです。

1. HTTP リスナーをキャンバスにドラッグして設定します。
2. **\[Palette (パレット)\]**​ から Salesforce Connector を検索して ​**\[Query\]**​ 操作をドラッグします。Salesforce 操作を設定するには、
    
    1. **\[Salesforce query (Salesforce クエリ)\]**​ でクエリを追加します。このデモでは、次のクエリを使用して Salesforce からアカウントを取得します。
        
        ```sql
        SELECT Id, AccountNumber, Phone, Name FROM Account where Id = ':sfId'
        ```
    2. **\[Parameters (パラメーター)\]**​ セクションで、​**\[Name (名前)\]**​ を ​`sfId`​、​**\[Value (値)\]**​ を ​`attributes.queryParams.sfcId`​ に設定してパラメーターを作成します。
3. Transform Message をキャンバス上のフローにドラッグして、Roostify Connector 用の入力を準備します。Transform Message の出力ペイロードの例を次に示します。
    
    ```json
    %dw 2.0
    output application/json
    ---
    {
    	user_role: "borrower",
    	home_phone: payload.Phone[0],
    	reference_id: "Test-ref-123",
    	last_name: "Demo",
    	account_id: payload.AccountNumber[0],
    	job_title: "ADMIN",
    	first_name: payload.Name[0],
    	email: payload.Id[0] ++ "@roostify.com"
    }
    ```
4. Roostify の操作から ​**Create a User**​ コネクタ操作をドラッグして、Transform Message の後ろに配置します。設定オプションで、次の操作を行います。
    
    1. 作成したコネクタ設定を選択します。
    2. コネクタ設定の ​**\[General (一般)\]**​ セクションを ​`payload`​ に設定します。
    3. **\[Advanced (詳細)\]**​ セクションの ​**\[Target Value (対象値)\]**​ を ​`#[payload]`​ に設定します。
5. Roostify から返されるユーザー ID を変数に取得するため、​**Mule パレット**​で ​**Set Variable**​ 操作を探して、Roostify 操作の後ろに配置します。​**Set Variable**​ 操作の ​**\[Settings (設定)\]**​ セクションで、以下を設定します。
    
    1. **名前**​: `userId`
    2. **値**​: `#[payload.id]`
6. Roostify 操作から ​**Create a Loan Application**​ 操作をドラッグします。設定オプションで、
    
    1. 次の​**「General (一般)」**​セクションの​**「Create loan request (ローン要求の作成)」**​にあるサンプルペイロードを使用します。
        
        ```json
        output application/json
        ---
        {
        	reference_id: vars.refId,
        	application_type: "purchase",
        	loan_amount: 20000,
        	down_payment: 1000,
        	amortization_term: "30"
        }
        ```
    2. **\[Advanced (詳細)\]**​ セクションの ​**\[Target Value (対象値)\]**​ を ​`#[payload]`​ に設定します。
7. Roostify から返されるローン ID を変数に取得するため、再び ​**Mule パレット**​で ​**Set Variable**​ 操作を探して、Roostify 操作の後ろに配置します。​**Set Variable**​ 操作の ​**\[Settings (設定)\]**​ セクションで、以下を設定します。
    
    1. **名前**​: `userId`
    2. **値**​: `#[payload.id]`
8. 別の Transform Message コンポーネントを使用して、JSON 形式で応答を表示します。Transform Message の出力ペイロードは、次のように設定できます。
    
    ```json
    %dw 2.0
    output application/json
    ---
    {
    	"RSF Account Id" : payload.account_id,
    	"User Id" : vars.userId,
    	"Loan Id" : vars.loanId
    }
    ```
9. アプリケーションを実行し、ブラウザーで ​`http://localhost:8081/createLoanApplication`​ を参照します。

## [](#ユースケース-xml-roostify-ユーザーとローンアプリケーションの作成)ユースケース XML: Roostify ユーザーとローンアプリケーションの作成

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:salesforce="http://www.mulesoft.org/schema/mule/salesforce" xmlns:roostify="http://www.mulesoft.org/schema/mule/roostify"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http
http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core
http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/roostify
http://www.mulesoft.org/schema/mule/roostify/current/mule-roostify.xsd
http://www.mulesoft.org/schema/mule/salesforce
http://www.mulesoft.org/schema/mule/salesforce/current/mule-salesforce.xsd">
	<flow name="CREATE_ROOSTIFY_USER_LOAN_APPLOCATION">
		<http:listener doc:name="8081/createLoanApplication"
		config-ref="HTTP_Listener_config" path="createLoanApplication"/>
		<salesforce:query doc:name="Get Salesforce Account" config-ref="Salesforce_Config">
			<salesforce:salesforce-query>SELECT Id, AccountNumber, Phone, Name  FROM Account where Id = ':sfId'</salesforce:salesforce-query>
			<salesforce:parameters><![CDATA[#[output application/java
---
{
	"sfId" : attributes.queryParams.sfcId
}]]]></salesforce:parameters>

		</salesforce:query>
		<ee:transform doc:name="Convert to JSON">
			<ee:message>
				<ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{
	user_role: "borrower",
	home_phone: payload.Phone[0],
	reference_id: "Test-ref-123",
	last_name: "Demo",
	account_id: payload.AccountNumber[0],
	job_title: "ADMIN",
	first_name: payload.Name[0]
}]]></ee:set-payload>
			</ee:message>
			<ee:variables>
				<ee:set-variable variableName="refId"><![CDATA[%dw 2.0
output application/java
---
{
	"refId" : "Test-ref-123"
}]]></ee:set-variable>
			</ee:variables>
		</ee:transform>
		<roostify:create-user doc:name="Create a User in Roostify" config-ref="Roostify_Config" />
		<set-variable value="#[payload.id]" doc:name="Save User ID" variableName="userId" />
		<roostify:creating-loan-application doc:name="Create a Loan Application in Roostify" config-ref="Roostify_Config">
			<roostify:create-loan-request><![CDATA[#[output application/json
---
{
	reference_id: vars.refId,
	application_type: "purchase",
	loan_amount: 20000,
	down_payment: 1000,
	amortization_term: "30"
}]]]></roostify:create-loan-request>

		</roostify:creating-loan-application>
		<set-variable value="#[payload.id]" doc:name="Save Loan ID" variableName="loanId" />
		<ee:transform doc:name="Display Response">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	"RSF Account Id" : payload.account_id,
	"User Id" : vars.userId,
	"Loan Id" : vars.loanId

}
]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

## [](#関連情報)関連情報

- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=6a8cbff8fd6598b1d42ea51eabf7045d07d72a9e22cece2b0845009db909a845 url=/mulesoft/current/ja-jp/roostify-connector/latest/roostify-connector-reference.md -->

# Roostify Connector リファレンス

Roostify Connector v1.0

Roostify 用 Anypoint Connector (Roostify Connector) により、顧客は完成したローンアプリケーションから、DBA、支店、またはチャネルに合わせて最適化された、直感的なデジタルユーザーエクスペリエンスを生み出すことができます。

拡張機能のメインクラスであり、設定、接続プロバイダー、操作、およびソースを宣言するエントリポイントです。

リリースノート: [Roostify Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/roostify-connector-release-notes-mule-4)

## [](#設定)設定

* * *

### [](#config)デフォルト設定

デフォルト設定

#### [](#パラメーター)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name (名前)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この設定の名前。コネクタはこの名前の設定を参照します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Connection (接続)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#config_connection">Connection (接続)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この設定に指定する接続型。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Address (住所)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">バージョン</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Expiration Policy (有効期限ポリシー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ExpirationPolicy">Expiration Policy (有効期限ポリシー)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#接続種別)接続種別

##### [](#config_connection)Connection (接続)

###### [](#パラメーター-2)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Username (ユーザー名)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password (パスワード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Proxy Configuration (プロキシ設定)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Default">Default (デフォルト)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use Persistent Connections (永続接続を使用)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max Connections (最大接続数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Connection Idle Timeout (接続アイドルタイムアウト)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">60000</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Stream Response (応答のストリーミング)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response Buffer Size (応答バッファサイズ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-1</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Connection Timeout (接続タイムアウト)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">60000</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">TLS Configuration (TLS 設定)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Tls">TLS</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection (再接続)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#Reconnection">Reconnection (再接続)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

## [](#サポートされている操作)サポートされている操作

- [Activate a User](#activateUser)
- [Create a Lead](#creatingLead)
- [Create a Loan Application](#creatingLoanApplication)
- [Create a Message](#creatingMessage)
- [Create a Status Update](#creatingStatusUpdate)
- [Create a Task from a File Content Task](#creatingFileContentTask)
- [Create a Task from a Form Task](#creatingTaskFromForm)
- [Create a Task from a Regular Task](#creatingRegularTask)
- [Create a Task from a Speed-bump Task](#creatingSpeedBumpTask)
- [Create a Task from a View-only Task](#creatingViewOnlyTask)
- [Create a Task from an Approval Task](#creatingTaskFromApproval)
- [Create a Webhook](#creatingWebhook)
- [Create a User](#createUser)
- [Create an Access Control Group](#createAccessControl)
- [Create or Update a Reference ID](#createUpdateReferenceId)
- [Deactivate a User](#cancelOrder)
- [Delete a Webhook](#deletingWebhook)
- [Download a Document](#downloadingDocument)
- [List Accounts](#listingAccounts)
- [List Documents](#listingDocuments)
- [List Loan Applications](#listingLoanApplications)
- [List Messages](#getMessages)
- [List Users](#listingUsers)
- [List Webhooks](#listingWebhooks)
- [Listing Tasks](#listingTasks)
- [Listing Webhook Events](#listingWebhookEvents)
- [Retrieve a Document Metadata](#retrievingDocument)
- [Retrieve a Lead](#getLead)
- [Retrieve a Loan Application](#loanApplicationsId)
- [Retrieve a Loan Application by Reference ID](#loanApplicationByReferenceId)
- [Retrieve a Loan Application in FNM Format](#loanApplicationsFNM)
- [Retrieve a Loan Application in MISMO Format](#loanApplicationsMISMO)
- [Retrieve a Message](#retrievingMessage)
- [Retrieve a Service](#retrieveYourService)
- [Retrieve a Task](#retrievingATask)
- [Retrieve a User](#retrievingUser)
- [Retrieve a User Settings](#userSettings)
- [Retrieve a Webhook](#retrievingWebhook)
- [Retrieve an Account](#retrievingAccount)
- [Retrieve an Integration Service](#retrievingSettings)
- [Update a Document Metadata](#updateDocument)
- [Update a Loan Application](#updatingLoanApplication)
- [Update a Task](#updateTask)
- [Update a User](#updateUser)
- [Update an Access Control Group](#updateAccessControl)
- [Upload or Create a Document](#creatingDocument)

## [](#操作)操作

### [](#activateUser)Activate a User

`<roostify:activate-user>`

#### [](#パラメーター-3)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ユーザー ID (必須)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Binary (バイナリ)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー)スロー

- 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

### [](#cancelOrder)Deactivate a User

`<roostify:cancel-order>`

#### [](#パラメーター-4)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ユーザー ID (必須)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-2)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Binary (バイナリ)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-2)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-2)スロー

- 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

### [](#createAccessControl)Create an Access Control Group

`<roostify:create-access-control>`

#### [](#パラメーター-5)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Access Control (アクセスコントロール)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アクセスコントロールリクエストボディ作成します。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-3)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-3)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-3)スロー

- 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

### [](#createUpdateReferenceId)Create or Update a Reference ID

`<roostify:create-update-reference-id>`

参照 ID により、ユーザーは外部サービスやインテグレーションを操作できます。このルートを使用することで、参照 ID が作成または更新されます。

#### [](#パラメーター-6)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Loan_id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新するローンアプリケーションの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reference Body (参照本文)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローンを更新するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-4)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-4)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-4)スロー

- 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

### [](#createUser)Create a User

`<roostify:create-user>`

ユーザーを作成します。

#### [](#パラメーター-7)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">User Body (ユーザー本文)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Roostify ユーザー作成リクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-5)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-5)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-5)スロー

- 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

### [](#creatingDocument)Upload or Create a Document

`<roostify:creating-document>`

ドキュメントをアップロードするには、ドキュメントを JSON として /documents に投稿します。ペイロード本文中の file\_content は、base64 でエンコードされたドキュメントのデータです。

#### [](#パラメーター-8)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Document (ドキュメント)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ドキュメントを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-6)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-6)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-6)スロー

- 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

### [](#creatingFileContentTask)Create a Task from a File Content Task

`<roostify:creating-file-content-task>`

ファイルコンテンツタスクからタスクを作成します。

#### [](#パラメーター-9)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">File Content Task (ファイルコンテンツタスク)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ファイルコンテンツタスクからタスクを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-7)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-7)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-7)スロー

- 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

### [](#creatingLead)Create a Lead

`<roostify:creating-lead>`

リードエンドポイントは、Roostify でリードを作成するためのパラメーターを受け入れます。各パラメーターを許可リストに登録しておかないと、システムでは受け入れられません。

#### [](#パラメーター-10)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create Lead (リードの作成)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">リードを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-8)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-8)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-8)スロー

- 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

### [](#creatingLoanApplication)Create a Loan Application

`<roostify:creating-loan-application>`

ローンアプリケーションの作成は、サービスごとに許可する必要があります。デフォルトではアクセスは拒否されます。ローンアプリケーションは、上記のすべての属性を API へのパラメーターとして渡すことで作成できます。

#### [](#パラメーター-11)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Create Loan Request (ローン要求の作成)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローンリクエストボディを作成します。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-9)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-9)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-9)スロー

- 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

### [](#creatingMessage)Create a Message

`<roostify:creating-message>`

アカウントのメールと名前を入力すると、このエンドポイントから作成される送信元アドレスは、そのアカウント名とメールアドレスを使用します。これらを入力しないと、[no-reply@deliver.roostify.com](mailto:no-reply@deliver.roostify.com) のようなアドレスからメールが送信されます。

#### [](#パラメーター-12)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Message (メッセージ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">メッセージを作成するためのメッセージリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-10)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-10)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-10)スロー

- 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

### [](#creatingRegularTask)Create a Task from a Regular Task

`<roostify:creating-regular-task>`

通常のタスクからタスクを作成します。

#### [](#パラメーター-13)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Regular Task (通常タスク)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">通常のタスクからタスクを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-11)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-11)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-11)スロー

- 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

### [](#creatingSpeedBumpTask)Create a Task from a Speed-bump Task

`<roostify:creating-speed-bump-task>`

スピードバンプタスクからタスクを作成します。

#### [](#パラメーター-14)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Speed Bump Task (スピードバンプタスク)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">スピードバンプタスクからタスクを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-12)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-12)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-12)スロー

- 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

### [](#creatingStatusUpdate)Create a Status Update

`<roostify:creating-status-update>`

状況の更新は、コラボレーターがローンアプリケーションへの更新を監視するために使用するストリーム内で発生します。

#### [](#パラメーター-15)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Status (状況)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">状況の更新を作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-13)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-13)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-13)スロー

- 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

### [](#creatingTaskFromApproval)Create a Task from an Approval Task

`<roostify:creating-task-from-approval>`

承認タスクから新しいタスクを作成します。

#### [](#パラメーター-16)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Approval Task (承認タスク)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">承認タスクからタスクを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-14)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-14)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-14)スロー

- 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

### [](#creatingTaskFromForm)Create a Task from a Form Task

`<roostify:creating-task-from-form>`

フォームタスクから新しいタスクを作成します。

#### [](#パラメーター-17)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Form Task (フォームタスク)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">フォームタスクからタスクを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-15)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-15)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-15)スロー

- 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

### [](#creatingViewOnlyTask)Create a Task from a View-only Task

`<roostify:creating-view-only-task>`

表示専用タスクからタスクを作成します。

#### [](#パラメーター-18)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">View Only Task (表示専用タスク)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">表示専用タスクからタスクを作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-16)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-16)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-16)スロー

- 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

### [](#creatingWebhook)Create a Webhook

`<roostify:creating-webhook>`

#### [](#パラメーター-19)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Webhook Body (Web ブック本文)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Web フック作成するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-17)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-17)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-17)スロー

- 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

### [](#deletingWebhook)Delete a Webhook

`<roostify:deleting-webhook>`

#### [](#パラメーター-20)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Webhook Id (Web フック ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">破棄する Web フックの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-18)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-18)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-18)スロー

- 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

### [](#downloadingDocument)Download a Document

`<roostify:downloading-document>`

#### [](#パラメーター-21)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">必須。取得するドキュメントの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-19)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-19)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-19)スロー

- 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

### [](#getLead)Retrieve a Lead

`<roostify:get-lead>`

リードエンドポイントは、Roostify でリードを作成するためのパラメーターを受け入れます。各パラメーターを許可リストに登録しておかないと、システムでは受け入れられません。

#### [](#パラメーター-22)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Lead Id (リード ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">リードの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-20)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-20)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-20)スロー

- 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

### [](#getMessages)List Messages

`<roostify:get-messages>`

#### [](#パラメーター-23)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-21)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-21)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-21)スロー

- 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

### [](#listingAccounts)List Accounts

`<roostify:listing-accounts>`

すべてのアカウントのリストを取得します。

#### [](#パラメーター-24)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-22)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-22)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-22)スロー

- 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

### [](#listingDocuments)List Documents

`<roostify:listing-documents>`

ドキュメントのメタデータを取得します。

#### [](#パラメーター-25)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter (検索条件)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">reference_id の有無によってドキュメントのメタデータを絞り込むための単語。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Search (検索)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ドキュメントのメタデータを検索するための単語。現時点で検索できる単語は、document_name、loan_application_reference_id、loan_application_id です。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-23)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-23)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-23)スロー

- 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

### [](#listingLoanApplications)List Loan Applications

`<roostify:listing-loan-applications>`

アカウントまたはその子孫に属するすべてのローンアプリケーションのリストを取得します。大量のローンアプリケーションを持つクライアントの場合は、ページネーションを使用しないとタイムアウトになる場合があります。

#### [](#パラメーター-26)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Search (検索)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">指定された属性と一致するローンアプリケーションのみをリストします。パラメーター構造は search[attribute]=…​ です。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Created (作成済み)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローンアプリケーションが作成された日付に基づいてローンアプリケーションを絞り込みます。文字列は、「…​」で区切られた 2 つの ISO-8601 日付スタンプの形式でなければなりません。タイムゾーン指定子を省略した場合はデフォルトの UTC となります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Submitted (送信済み)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローンアプリケーションが送信された日付に基づいてローンアプリケーションを絞り込みます。文字列は、「…​」で区切られた 2 つの ISO-8601 日付スタンプの形式でなければなりません。タイムゾーン指定子を省略した場合はデフォルトの UTC となります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Updated (更新済み)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローンアプリケーションが更新された日付に基づいてローンアプリケーションを絞り込みます。文字列は、「…​」で区切られた 2 つの ISO-8601 日付スタンプの形式でなければなりません。タイムゾーン指定子を省略した場合はデフォルトの UTC となります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-24)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-24)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-24)スロー

- 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

### [](#listingTasks)Listing Tasks

`<roostify:listing-tasks>`

すべてのタスクとそれぞれの詳細のリストを返します。

#### [](#パラメーター-27)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Loan_application_id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">関連付けられているタスクを検索するローンアプリケーション ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページ番号を示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-25)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-25)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-25)スロー

- 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

### [](#listingUsers)List Users

`<roostify:listing-users>`

すべてのユーザーとそれぞれの詳細のリストを返します。

#### [](#パラメーター-28)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Search (検索)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">指定された属性と一致するユーザーのみをリストします。パラメーター構造は search[attribute]=…​ です。URL エンコードされた検索パラメーターのハッシュを取ります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-26)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-26)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-26)スロー

- 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

### [](#listingWebhookEvents)Listing Webhook Events

`<roostify:listing-webhook-events>`

Web フックイベントは、特定のイベントに対して Web フックが実行されたすべてのインスタンスを記録し、Web フックで追跡可能なすべてのイベントの監査ログとして使用できます。

#### [](#パラメーター-29)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Created (作成済み)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ISO 8601 DateTime range (ISO 8601 日時範囲)。返された結果を、この日付範囲内に作成された Web フックイベントのみに絞り込みます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-27)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-27)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-27)スロー

- 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

### [](#listingWebhooks)List Webhooks

`<roostify:listing-webhooks>`

#### [](#パラメーター-30)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Page (ページ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるインデックスのページを示します。このパラメーターを指定せずに、count パラメーターを指定した場合は、デフォルトで 1 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">返されるページごとのレコード数を示します。このパラメーターを指定せずに、page パラメーターを指定した場合は、デフォルトで 100 になります。どちらのパラメーターも指定しないと、ページネーションは無効になります。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-28)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-28)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-28)スロー

- 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

### [](#loanApplicationByReferenceId)Retrieve a Loan Application by Reference ID

`<roostify:loan-application-by-reference-id>`

#### [](#パラメーター-31)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reference Id (参照 ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得するローンアプリケーションの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-29)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-29)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-29)スロー

- 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

### [](#loanApplicationsFNM)Retrieve a Loan Application in FNM Format

`<roostify:loan-applications-fnm>`

ほとんどの API とは異なり、ローンアプリケーション FNM エンドポイントは、JSON ではなくプレーンテキストを返します。返される文字列は、Base64 でエンコードされた Fannie Mae (連邦住宅抵当公庫) ファイルです。

#### [](#パラメーター-32)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得するローンアプリケーションの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-30)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Binary (バイナリ)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-30)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-30)スロー

- 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

### [](#loanApplicationsId)Retrieve a Loan Application

`<roostify:loan-applications-id>`

#### [](#パラメーター-33)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Find_id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得するローンアプリケーションの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-31)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-31)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-31)スロー

- 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

### [](#loanApplicationsMISMO)Retrieve a Loan Application in MISMO Format

`<roostify:loan-applications-mismo>`

ローンアプリケーションを MISMO 形式でダウンロードするには、パートナーまたはクライアントのサクセスマネージャーからの要求が必要です。

#### [](#パラメーター-34)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得するローンアプリケーションの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-32)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Binary (バイナリ)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-32)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-32)スロー

- 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

### [](#retrieveYourService)Retrieve a Service

`<roostify:retrieve-your-service>`

Roostify でビルドされたアプリケーションは、特定のユーザーやアカウントに紐付けられた設定または他の種類のデータを必要とすることがあります。たとえば、Roostify からローン組成システムに対してローンアプリケーションを同期させる製品をビルドする場合、融資会社を適切に割り当てることができるように、融資会社に対してローン組成システムのユーザー名を入力するように求めることが考えられます。これらはユーザー設定と見なされます。アカウント設定は、同じアカウントのユーザーグループで共有されるデータに適用されます。融資会社とアカウント管理者は、Roostify UI でこれらの設定の値を定義できます。

#### [](#パラメーター-35)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-33)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-33)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-33)スロー

- 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

### [](#retrievingATask)Retrieve a Task

`<roostify:retrieving-a-task>`

単一タスクの詳細を取得します。

#### [](#パラメーター-36)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Task Id (タスク ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">タスクの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-34)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-34)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-34)スロー

- 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

### [](#retrievingAccount)Retrieve an Account

`<roostify:retrieving-account>`

Roostify ユーザーはいずれかのアカウントのメンバーとなります。請求、権限、サービスインテグレーション、アプリケーションとワークフローのカスタマイズ、共同ブランディングスタイルなどは、アカウント単位で管理されます。 サービスに統合されているアカウントであれば、その基本情報にアクセスできます。

#### [](#パラメーター-37)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アカウントの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-35)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-35)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-35)スロー

- 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

### [](#retrievingDocument)Retrieve a Document Metadata

`<roostify:retrieving-document>`

ドキュメントのメタデータを取得します。

#### [](#パラメーター-38)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Find_id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得するドキュメントの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-36)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-36)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-36)スロー

- 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

### [](#retrievingMessage)Retrieve a Message

`<roostify:retrieving-message>`

#### [](#パラメーター-39)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Message Id (メッセージ ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得するメッセージの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-37)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-37)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-37)スロー

- 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

### [](#retrievingSettings)Retrieve an Integration Service

`<roostify:retrieving-settings>`

Roostify サービスは、アカウントレベルでカスタマイズできます。/settings エンドポイントを使用して、サービスの設定にアクセスできます。これらはキー/値ペアとして返されます。たとえば、Roostify が設定を必要とするインテグレーションを利用している場合、この GET 要求によって、設定の項目と値、そしてアカウントに関連付けられている融資会社が返されます。

#### [](#パラメーター-40)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-38)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-38)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-38)スロー

- 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

### [](#retrievingUser)Retrieve a User

`<roostify:retrieving-user>`

単一ユーザーの詳細を取得します。

#### [](#パラメーター-41)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">User Id (ユーザー ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ユーザーの ID</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-39)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-39)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-39)スロー

- 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

### [](#retrievingWebhook)Retrieve a Webhook

`<roostify:retrieving-webhook>`

#### [](#パラメーター-42)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Webhook Id (Web フック ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取得する Web フックの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-40)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-40)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-40)スロー

- 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

### [](#updateAccessControl)Update an Access Control Group

`<roostify:update-access-control>`

#### [](#パラメーター-43)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Access Control Group (アクセスコントロールグループ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アクセスコントロール更新リクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">タスクの ID またはシステム名。指定した文字列と一致する ID を検索しても結果が返されない場合は、システム名での検索が試みられます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-41)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-41)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-41)スロー

- 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

### [](#updateDocument)Update a Document Metadata

`<roostify:update-document>`

ドキュメントのメタデータを更新して、ドキュメントのメタデータを返します。

#### [](#パラメーター-44)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Document Body (ドキュメント本文)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ドキュメントを更新するためリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新するドキュメントの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-42)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-42)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-42)スロー

- 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

### [](#updateTask)Update a Task

`<roostify:update-task>`

単一タスクの詳細を取得します。

#### [](#パラメーター-45)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Task Body (タスク本文)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">タスクを更新するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Task Id (タスク ID)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">タスクの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-43)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-43)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-43)スロー

- 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

### [](#updateUser)Update a User

`<roostify:update-user>`

#### [](#パラメーター-46)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">ユーザー</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ユーザーを更新するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ユーザー ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Mime Type (出力 MIME タイプ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードの MIME タイプ。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output Encoding (出力エンコード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この操作で出力されるペイロードのエンコード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-44)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Binary (バイナリ)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-44)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-44)スロー

- 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

### [](#updatingLoanApplication)Update a Loan Application

`<roostify:updating-loan-application>`

ローンアプリケーションの更新は、サービスごとに許可する必要があります。デフォルトではアクセスは拒否されます。

#### [](#パラメーター-47)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Update_id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">更新するローンアプリケーションの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Update Loan Request (ローン更新要求)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ローンアプリケーションを更新するためのリクエストボディ。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-45)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-45)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-45)スロー

- 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

### [](#userSettings)Retrieve a User Settings

`<roostify:user-settings>`

特定のユーザーの設定を取得すると、そのユーザーが属するアカウントの設定も返されます。特定のユーザーに関するすべての設定を単一の要求で取得できるため、操作が簡素化されます。

#### [](#パラメーター-48)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration (設定)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する設定の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Id</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">設定を取得するユーザーの ID。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Streaming Strategy (ストリーミング戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream (反復可能なメモリ内ストリーム)</a>​</p>
</li>
<li>
<p><a href="#repeatable-file-store-stream">Repeatable File Store Stream (反復可能なファイルストアストリーム)</a>​</p>
</li>
<li>
<p>non-repeatable-stream</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">反復可能なストリームを使用するように設定します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力を保存する変数の名前。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">操作の出力に対して評価される式。この式の結果が対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>#[payload]</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">接続エラーが発生した場合の再試行戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

#### [](#出力-46)出力

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">型</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Any (任意)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Attributes Type (属性型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ResponseStatus">応答状況</a></p>
</div></div></td>
</tr>
</tbody>
</table>

#### [](#次の設定の場合-46)次の設定の場合

- [デフォルト設定](#config)

#### [](#スロー-46)スロー

- 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)Default (デフォルト)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Host (ホスト)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">プロキシ要求が送信されるホスト。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Port (ポート)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">プロキシ要求が送信されるポート。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Username (ユーザー名)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">プロキシに対して認証するユーザー名。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password (パスワード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">プロキシに対して認証するパスワード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Non Proxy Hosts (非プロキシホスト)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">プロキシの使用対象にならないカンマ区切りホストのリスト。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#Tls)TLS

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enabled Protocols (有効化されたプロトコル)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンテキストで有効化されたプロトコルのカンマ区切りリスト。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enabled Cipher Suites (有効化された暗号化スイート)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Trust Store (トラストストア)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#TrustStore">トラストストア</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key Store (キーストア)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#KeyStore">Key Store (キーストア)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Revocation Check (取り消し確認)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#standard-revocation-check">Standard Revocation Check (標準の取り消し確認)</a>​</p>
</li>
<li>
<p><a href="#custom-ocsp-responder">Custom OCSP Responder (カスタム OCSP レスポンダー)</a>​</p>
</li>
<li>
<p><a href="#crl-file">CRL File (CRL ファイル)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#TrustStore)トラストストア

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password (パスワード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">トラストストアを保護するために使用するパスワード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type (型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用するストアの型。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Algorithm (アルゴリズム)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">トラストストアで使用するアルゴリズム。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Insecure (安全ではない)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#KeyStore)Key Store (キーストア)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type (型)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用するストアの型。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Alias (別名)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key Password (キーパスワード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">非公開キーを保護するために使用するパスワード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Password (パスワード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">キーストアを保護するために使用するパスワード。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Algorithm (アルゴリズム)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">キーストアで使用するアルゴリズム。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#standard-revocation-check)Standard Revocation Check (標準の取り消し確認)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Only End Entities (最後のエンティティのみ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">証明書チェーンの最後の要素のみを確認します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Prefer CRLs (CRL を優先)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">最初に OCSP ではなく CRL を試みます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">No Fallback (代替なし)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">第 2 の確認方法 (以前に選択されていない方法) を使用しません。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Soft Fail (ソフトフェール)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#custom-ocsp-responder)Custom OCSP Responder (カスタム OCSP レスポンダー)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Url</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">OCSP レスポンダーの URL。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cert Alias (証明書の別名)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#crl-file)CRL File (CRL ファイル)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path (パス)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CRL ファイルへのパス。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#Reconnection)Reconnection (再接続)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Fails Deployment (デプロイメントに失敗)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reconnection Strategy (再接続戦略)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p><a href="#reconnect">Reconnect (再接続)</a>​</p>
</li>
<li>
<p><a href="#reconnect-forever">Reconnect Forever (繰り返し再接続)</a></p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用する再接続戦略。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#reconnect)Reconnect (再接続)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Frequency (頻度)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">再接続する頻度 (ミリ秒)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Count (数)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">再接続の試行回数。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">blocking (ブロック)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean (ブール)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Frequency (頻度)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">再接続する頻度 (ミリ秒)。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">blocking (ブロック)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean (ブール)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max Idle Time (最大アイドル時間)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Time Unit (時間単位)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NANOSECONDS (ナノ秒)</p>
</li>
<li>
<p>MICROSECONDS (マイクロ秒)</p>
</li>
<li>
<p>MILLISECONDS (ミリ秒)</p>
</li>
<li>
<p>SECONDS (秒)</p>
</li>
<li>
<p>MINUTES (分)</p>
</li>
<li>
<p>HOURS (時間)</p>
</li>
<li>
<p>DAYS (日)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">maxIdleTime 属性の時間単位</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#ResponseStatus)応答状況

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Headers (ヘッダー)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Object (オブジェクト)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Status Code (状況コード)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#repeatable-in-memory-stream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Initial Buffer Size (初期バッファサイズ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Buffer Size Increment (バッファサイズ増分)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max Buffer Size (最大バッファサイズ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Buffer Unit (バッファ単位)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>BYTE (バイト)</p>
</li>
<li>
<p>KB</p>
</li>
<li>
<p>MB</p>
</li>
<li>
<p>GB</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">これらのすべての属性の単位</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

### [](#repeatable-file-store-stream)Repeatable File Store Stream (反復可能なファイルストアストリーム)

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">項目</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max In Memory Size (最大メモリ内サイズ)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Buffer Unit (バッファ単位)</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>BYTE (バイト)</p>
</li>
<li>
<p>KB</p>
</li>
<li>
<p>MB</p>
</li>
<li>
<p>GB</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">maxInMemorySize で表される単位</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>

## [](#関連情報)関連情報

[MuleSoft ヘルプセンター](https://help.mulesoft.com)