Skip to main content

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

 

 

OutSystems

REST API

他のシステムがRESTを通じて情報を取得または操作できるようにするメソッドを公開するAPI。

プロパティ

名前 説明 必須 デフォルト値 備考
Name 画面、アクション、モジュールといった、定義されているスコープ内の要素を識別します。 Yes
Description 要素を文書化するテキスト。 文書化の際に便利です。
このプロパティの最大サイズは2,000文字です。
Icon この要素を識別するために表示される画像。 Yes
URL すべてのREST APIメソッドのベースURL。
セキュリティ
HTTP Security HTTPリクエストに必要なセキュリティレベル。環境またはインフラで設定されたセキュリティレベルで上書きできます。 Yes SSL/TLS
Authentication HTTPリクエスト内で要求される認証。コールバックアクションOnAuthenticationは、ベーシック認証またはカスタム認証を実装するために使用できます。 Yes None
Internal Access Only 内部ネットワークにアクセス可能なユーザーのみがWebサービスにアクセスできます。 Yes No
高度
Documentation [Yes]に設定すると、REST APIベースのURLで自動的にドキュメントページを生成できます。 Yes Yes
Send Default Values デフォルト値を保持している場合は、レスポンスペイロード内の入力パラメータの値を送信します。 Yes No
On Request REST APIメソッドに到達する前にリクエストをカスタマイズするアクション。
On Response 送信前にレスポンスをカスタマイズするアクション。
  • Was this article helpful?