OutSystems API
OutSystemsには、アプリケーションの機能を拡張できるAPIが用意されています。これらのAPIを使用すると、アプリケーションを外部システムと連携したり、OutSystemsの機能にプログラムでアクセスしたりすることができます。
使用できるAPIは以下のとおりです。
ビジネスプロセス
| API名 | 利用方法 | 説明 |
|---|---|---|
| BPT API | 参照エクステンション | プロセスとアクティビティを管理するための機能を提供します。 |
| Processes API | 参照システムモジュール | OutSystemsデータモデルから情報を取得し、プロセスの設計をカスタマイズ・拡張することができます。 |
| EPA TaskBox API | 参照モジュール | BPTタスクボックスへのアクセスを提供します。BPTタスクボックスの機能は、仕様に応じて拡張できます。 |
チャート
| API名 | 利用方法 | 説明 |
|---|---|---|
| Charts API | 参照モジュール | Webやモバイルデバイスでチャートの描画を可能にします。 |
クライアント側動作
| API名 | 利用方法 | 説明 |
|---|---|---|
| outsystems.api.preloader API | 参照エクステンションおよびJavaScriptファイル | モジュールのリストの静的リソース（css、js、png、gif、jpg、jpeg、woff）のプリフェッチを可能にするJavaScript API。 |
| outsystems.api.requestInfo API | 事前定義済みJavaScriptオブジェクト | 現在のリクエストとセッションに関する情報を取得するためのメソッドを提供するJavaScript API。 |
データベース
| API名 | 利用方法 | 説明 |
|---|---|---|
| DbCleaner API | 参照モジュール | エンティティ、アトリビュート、モジュールバージョンに関連するデータベース内のテーブルや列を削除するアクションを提供します。 |
| PlatformRuntime API | 参照エクステンション | 実行時にアプリケーションによるデータベース接続の切り替えを可能にします。 |
| RuntimePublic.Db API | .NETクラス | エクステンションモジュールによる環境コンソールで構成されたデータベースの呼び出しを可能にします。 |
メール
| API名 | 利用方法 | 説明 |
|---|---|---|
| Emails API | 参照システムモジュール | メールに関するデータへのアクセスを可能にします。 |
エンドユーザー管理
| API名 | 利用方法 | 説明 |
|---|---|---|
| Users API | 参照モジュール | プログラムによるOutSystemsのユーザーとロールの管理を可能にします。 |
インフラおよびITユーザー管理
| API名 | 利用方法 | 説明 |
|---|---|---|
| LifeTime API | REST API | OutSystemsインフラのアプリケーション、モジュール、環境、デプロイの管理を可能にします。 |
| LifeTime Services API | SOAP Webサービス | OutSystemsで利用できるインフラを管理する機能を提供します。 |
| LifeTime SDK | 参照モジュール | 独自プラグインの開発など、LifeTimeの機能を拡張するためのAPI。 |
連携
| API名 | 利用方法 | 説明 |
|---|---|---|
| BinaryData API | 参照エクステンション | テキストとBase64テキストの相互変換、エンコード変換、バイナリコンテンツ長、バイナリデータ比較など、バイナリコンテンツを操作するためのAPI。 |
| EnhancedWebReferences API | 参照エクステンション | WebサービスとWeb参照のURL、SOAPヘッダー、資格情報、プロキシを動的に変更するためのAPI。 OutSystems 11にアップグレードされた公開SOAP Webサービスおよび利用中のSOAP Webサービスに適用されます。 |
| HTTPRequestHandler API | 参照エクステンション | HTTPリクエストとHTTPレスポンスを操作できる機能を持つAPI。 |
| REST Extensibility API | .NETクラス | 他のREST APIから利用されるメソッドが使用するリクエストとレスポンスのコンテンツへのアクセスを可能にするAPI。 |
| SAP Extensibility API | .NETライブラリ | エクステンションによるSAPリモート機能への接続と呼び出しのカスタマイズを可能にするAPI。 |
| SOAP Extensibility API | .NETクラス | .NETコードを使用したSOAP接続やリクエスト/レスポンスメッセージの変更を可能にするAPI。 OutSystems11で作成したSOAP Webサービスの利用に適用されます。 |
監視とトレーサビリティ
| API名 | 利用方法 | 説明 |
|---|---|---|
| Asynchronous Logging API | 参照エクステンション | 拡張性の高いロギング実行メカニズムを提供します。 |
| PerformanceMonitoring API | REST API | アプリケーションのリクエストイベントを取得または登録するためのREST APIメソッドを提供します。リクエストイベントには、アプリケーションのユーザーエクスペリエンスに関するメトリックが含まれます。 |
スクリプト
| API名 | 利用方法 | 説明 |
|---|---|---|
| IncludeJavaScript API | 参照エクステンション | プログラムによるJavaScriptスニペットのすべてのWeb画面への組み込みを可能にします。 |
| JavaScript API | 事前定義済みJavaScriptオブジェクト | JavaScriptコード内でのOutSystemsの特定のアクションの呼び出しやモバイルアプリイベントへの対応、最終ユーザーのモバイルアプリエクスペリエンスの微調整やカスタマイズを可能にします。 |
システムアクション
| API名 | 利用方法 | 説明 |
|---|---|---|
| System Actions | 参照システムモジュール | リストやアクティビティなどのシステム要素に対する操作を可能にするクライアントアクションとサーバーアクションが含まれます。 |
セキュリティと暗号
| API名 | 利用方法 | 説明 |
|---|---|---|
| PlatformPasswordUtils API | 参照エクステンション | 確立された暗号手法に準拠し、データベース内のパスワードを検証して安全に保存するためのアクションを提供します。 |
| Sanitization API | 参照エクステンション | 信頼できないコンテンツ（エンドユーザーから収集されるコンテンツ）を含める必要があるHTML、JavaScript、SQLスニペットでコードインジェクションを防ぐためのメソッドを提供します。 |
テキスト
| API名 | 利用方法 | 説明 |
|---|---|---|
| Text API | 参照エクステンション | 正規表現を使用した検索と置換、分割、日時の書式設定などのテキスト操作機能を提供します。 |
Charts API
- Webアプリでチャートを描画するためのウィジェットを含むコンポーネント。
- このカテゴリの記事:
LifeTime API v2
- OutSystemsインフラのアプリケーション、モジュール、環境、デプロイを管理できます。このAPIのバージョン2では、デプロイメントゾーン、ユーザー、チーム、ロールのサポートが追加されています。
- このカテゴリの記事:
RuntimePublic.Db API
- 外部データベースとの連携を可能にするための機能を提供します。
- このカテゴリの記事:
このセクションの記事
- Asynchronous Logging API
- Asynchronous Logging APIは、データベースへのレコードの挿入やアプリケーションのリクエストイベントの登録を非同期で実行するためのアクションを提供します。
- BinaryData API
- 長さの取得やバイナリからテキストへのコンテンツの変換など、バイナリデータコンテンツを操作するためのアクションを提供します。
- BPT API
- プロセスアクティビティ用のカスタム受信トレイを作成するための低レベルAPI。
- DbCleaner API
- データベースの空き領域を確保します。
- Emails API
- Emails APIを使用すると、OutSystemsデータモデルから情報を取得し、メールの設計をカスタマイズ・拡張することができます。
- EnhancedWebReferences API
- WebサービスとWeb参照のURL、SOAPヘッダー、資格情報、プロキシを動的に変更するためのAPI。
- EPA Taskbox API
- EPA（Embedded Process Automation）は、すべての保留中のアクティビティをユーザーのWebブラウザの移動タスクボックスに自動的に表示します。
- HTTPRequestHandler API
- HTTPリクエストとHTTPレスポンスを操作するためのアクションを提供します。
- IncludeJavascript API
- 環境内で実行されているすべてのWebアプリのWeb画面にスクリプトを含めるためのAPI。
- LifeTime API v1
- OutSystemsインフラのアプリケーション、モジュール、環境、デプロイを管理できます。
- LifeTime SDK
- LifeTimeとそのプラグインで使用されるコアレイアウトコンポーネントとAPI。
- LifeTime Services API
- SOAP Webサービスにより、OutSystemsで利用可能なインフラを管理することができます。
- outsystems.api.preloader API
- モジュールのリストの静的リソース（css、js、png、gif、jpg、jpeg、woff）のプリフェッチを可能にするJavaScript API。
- outsystems.api.requestInfo API
- 現在のリクエストとセッションに関する情報を取得するためのメソッドを提供するJavaScript API。
- PerformanceMonitoring API
- OutSystemsプラットフォームによってログに記録された、分析に役立つデータを含むリクエストイベントにアクセスするためのAPI。アプリケーションのユーザーエクスペリエンスを分析するために使用できます。
- PlatformPasswordUtils API
- 確立された暗号手法に準拠し、データベース内のパスワードを検証して安全に保存するためのアクションを提供します。
- PlatformRuntime API
- 環境の実行時構成を操作できます。
- Processes API
- Processes APIを使用すると、OutSystemsデータモデルから情報を取得し、プロセスの設計をカスタマイズ・拡張することができます。
- REST Extensibility API
- .NETで他のREST APIから利用されるメソッドが使用するリクエストとレスポンスのコンテンツへのアクセスを可能にします。
- Sanitization API
- 信頼できないコンテンツ（エンドユーザーから収集されるコンテンツ）を含める必要があるHTML、JavaScript、SQLスニペットでコードインジェクションの回避に役立つメソッドを提供するAPI。
- SAP Extensibility API
- OutSystems SAP Extensibility APIは、エクステンションによるSAPリモート機能への接続と呼び出しのカスタマイズを可能にします。
- SOAP Extensibility API
- エクステンションのSOAP接続やリクエスト/レスポンスメッセージの変更を可能にします。
- システムアクション
- リスト操作を含む、OutSystemsで利用可能なシステムアクション（サーバーアクションとクライアントアクションの両方）のリスト。
- Text API
- 結合、分割、正規表現を使用した検索と置換、日時表記のカスタム書式設定など、文字列操作のためのアクションを提供します。
- Users API
- ユーザー、グループ、ロールを管理するためのAPI。