Skip to main content

 

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

Java用REST Extensibility API

OutSystems REST Extensibility APIは、他のREST APIから利用されるメソッドが使用するリクエストとレスポンスのコンテンツにアクセスできるようをにします。これは、インストール時に自動的に環境にインポートされます。

リクエスト/レスポンスを操作するには、拡張モジュールを作成して利用中のREST APIのOnBeforeRequestAdvanced/OnAfterResponseAdvancedコールバックでそのメソッドを使用します。詳細については、リクエスト/レスポンスをカスタマイズする方法をご覧ください。

このトピックで説明されているコンポーネントは、次のパッケージで使用できます: outsystems.runtimepublic.rest

これらの利用方法の例については、OutSystems ForgeのComponentsカテゴリでREST APIを利用するモジュールを検索してください。

RestRequestクラス

このオブジェクトは、利用中のREST APIのメソッドの実行時に使用されるリクエストオブジェクトへの低レベルのアクセスを提供します。

メソッド

名前 説明
static
RestRequest getCurrent()
REST APIから利用されるメソッドによって使用されるリクエストオブジェクトを返します。OnBeforeRequestAdvancedコールバック内でのみ使用する必要があります。それ以外の場合はnullが返されます。
例: このクラスのインスタンスを取得するには、RestRequest.getCurrent()を使用します。
string
GetActionName()
拡張機能を呼び出したREST APIから利用されるメソッドの名前を返します。
HttpClient
getHttpClient()
Webリクエストを実行するために使用されたネイティブHttpClientオブジェクトを返します。
HttpUriRequest
getHttpUriRequest()
Webリクエストを実行するために使用されたネイティブHttpUriRequestオブジェクトを返します。
byte[]
getRequestBodyAsBinary()
Webリクエストのメッセージボディをバイナリコンテンツとして返します。
String
getRequestBodyAsText()
Webリクエストのメッセージボディを文字列として返します。
void
setRequestBody(byte[] bytes)
Webリクエストのメッセージボディをバイナリコンテンツで設定します。
void
setRequestBody(String text)
Webリクエストのメッセージボディをテキストで設定します。メソッドのRequest Formatプロパティが「Binary」に設定されている場合、メッセージボディの変更は行われません。
void
setHttpClient(HttpClient httpClient)
Webリクエストを実行するために使用されたネイティブHttpClientオブジェクトを設定します。

RestResponseクラス

このオブジェクトは、利用中のREST APIのメソッドの実行時のレスポンスオブジェクトへの下位レベルのアクセスを提供します。

メソッド

名前 説明
static
RestResponse getCurrent()
REST APIから利用されるメソッドによって使用されるレスポンスオブジェクトを返します。OnAfterResponseAdvancedコールバック内でのみ使用する必要があります。それ以外の場合はnullが返されます。
例: このクラスのインスタンスを取得するには、RestResponse.getCurrent()を使用します。
string
GetActionName()
拡張機能を呼び出したREST APIから利用されるメソッドの名前を返します。
HttpClient
getHttpClient()
Webリクエストの結果として得られるネイティブHttpClientオブジェクトを返します。
HttpResponse
getHttpResponse()
Webリクエストの結果として得られるネイティブHttpResponseオブジェクトを返します。
byte[]
getResponseBodyAsBinary()
Webレスポンスのメッセージボディをバイナリコンテンツとして返します。
String
getResponseBodyAsText()
Webレスポンスのメッセージボディを文字列として返します。
void
setResponseBody(byte[] bytes)
Webレスポンスのメッセージボディをバイナリコンテンツで設定します。
void
setResponseBody(String text)
Webレスポンスのメッセージボディをテキストで設定します。メソッドのResponse Formatプロパティが「Binary」に設定されている場合、メッセージボディの変更は行われません。
  • Was this article helpful?