REST Extensibility API
OutSystems REST Extensibility APIは、他のREST APIから利用されるメソッドが使用するリクエストとレスポンスのコンテンツへのアクセスを可能にします。これは、インストール時に自動的に環境にインポートされます。
リクエスト/レスポンスを操作するには、エクステンションモジュールを作成して利用中のREST APIのOnBeforeRequestAdvanced/OnAfterResponseAdvancedコールバックでそのメソッドを使用します。詳細については、リクエスト/レスポンスをカスタマイズする方法をご覧ください。
このトピックで説明されているコンポーネントは、.NET名前空間OutSystems.RuntimePublic.REST
これらの利用方法の例については、OutSystems ForgeのComponentsカテゴリでREST APIを利用するモジュールを検索してください。
RestRequestクラス
このオブジェクトは、利用中のREST APIのメソッドの実行時に使用されるリクエストオブジェクトへの低レベルのアクセスを提供します。リクエストを操作するには、エクステンションモジュールを作成して利用中のREST APIのOnBeforeRequestAdvancedコールバックでそのメソッドを使用します。
メソッド
| 名前 | 説明 |
|---|---|
| static RestRequest GetCurrent() |
REST APIから利用されるメソッドによって使用されるリクエストオブジェクトを返します。OnBeforeRequestAdvancedコールバック内でのみ使用する必要があります。それ以外の場合はnullが返されます。 例: このクラスのインスタンスを取得するには、RestRequest.GetCurrent()を使用します。 |
| string GetActionName() |
エクステンションを呼び出したメソッドの名前を返します。 |
| HttpWebRequest GetHttpWebRequest() |
Webリクエストを実行するために使用されたネイティブHttpWebRequestオブジェクトを返します。 |
| byte[] GetRequestBodyAsBinary() |
Webリクエストのメッセージボディをバイナリコンテンツとして返します。 |
| string GetRequestBodyAsText() |
Webリクエストのメッセージボディを文字列として返します。 |
| void SetRequestBody(byte[] bytes) |
Webリクエストのメッセージボディをバイナリコンテンツで設定します。 |
| void SetRequestBody(string text) |
Webリクエストのメッセージボディをテキストで設定します。メソッドのRequest Formatプロパティが「Binary」に設定されている場合、メッセージボディの変更は行われません。 |
RestResponseクラス
このオブジェクトは、利用中のREST APIのOnAfterResponseAdvaコールバックの実行時のレスポンスオブジェクトへの下位レベルのアクセスを提供します。
メソッド
| 名前 | 説明 |
|---|---|
| static RestResponse GetCurrent() |
REST APIから利用されるメソッドによって使用されるレスポンスオブジェクトを返します。利用中のREST APIのOnAfterResponseAdvancedコールバック内でのみ使用する必要があります。それ以外の場合はnullが返されます。 例: このクラスのインスタンスを取得するには、RestResponse.GetCurrent()を使用します。 |
| string GetActionName() |
エクステンションを呼び出したメソッドの名前を返します。 |
| HttpWebResponse GetHttpWebResponse() |
Webリクエストの結果として得られるネイティブHttpWebResponseオブジェクトを返します。 |
| byte[] GetResponseBodyAsBinary() |
Webレスポンスのメッセージボディをバイナリコンテンツとして返します。 |
| string GetResponseBodyAsText() |
WebレスポンストのメッセージボディをContent-Typeヘッダーで指定されたエンコードの文字列として返します。 |
| void SetResponseBody(byte[] bytes) |
Webレスポンスのメッセージボディをバイナリコンテンツで設定します。 |
| void SetResponseBody(string text) |
Webレスポンスのメッセージボディをテキストで設定します。メソッドのResponse Formatプロパティが「Binary」に設定されている場合、メッセージボディの変更は行われません。 |