Skip to main content

 

OutSystems 11オンラインヘルプ

 

OutSystems

OutSystems API

OutSystemsには、アプリケーションの機能を拡張できるAPIが用意されています。これらのAPIを使用すると、アプリケーションを外部システムと連携することやOutSystemsの機能にプログラムでアクセスすることができます。

使用できるAPIは以下のとおりです。

ビジネスプロセス

API名 利用方法 説明
BPT API 参照拡張機能 LifeTimeによって管理される環境から収集されたパフォーマンス監視データを提供します。
Processes API 参照システムモジュール 拡張性の高いロギング実行メカニズムを提供します。
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 Deployment API REST API OutSystemsインフラのアプリケーション、モジュール、環境、デプロイの管理を可能にします。
LifeTime Services API SOAP Webサービス OutSystemsで利用できるインフラを管理する機能を提供します。
LifeTime SDK 参照モジュール 独自プラグインの開発など、LifeTimeの機能を拡張するためのAPI。

統合

API名 利用方法 説明
BinaryData API 参照拡張機能 テキストとBase64テキストの相互変換、エンコード変換、バイナリコンテンツ長、バイナリデータ比較など、バイナリコンテンツを操作するためのAPI。
EnhancedWebReferences API 参照拡張機能 (非推奨のAPI)WebサービスとWeb参照のURL、SOAPヘッダー、資格情報、プロキシを動的に変更するためのAPI。
HTTPRequestHandler API 参照拡張機能 HTTPリクエストとHTTPレスポンスを操作できる機能を持つAPI。
REST Extensibility API .NETクラス 他のREST APIから利用されるメソッドが使用するリクエストとレスポンスのコンテンツへのアクセスを可能にするAPI。
SAP Extensibility API .NETライブラリ 拡張機能によるSAPリモート機能への接続と呼び出しのカスタマイズを可能にするAPI。

監視およびトレーサビリティ

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 参照拡張機能 正規表現を使用した検索と置換、分割、日時の書式設定などのテキスト操作機能を提供します。

このセクションの記事

  • 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ブラウザの移動タスクボックスに自動的に表示します。EPA(Embedded Process Automation)は、すべての保留中のアクティビティをユーザーのWebブラウザの移動タスクボックスに自動的に表示します。
  • HTTPRequestHandler API
    HTTPリクエストとHTTPレスポンスを操作するためのアクションを提供します。
  • IncludeJavascript API
    環境内で実行されているすべてのWebアプリのWeb画面にスクリプトを含めるためのAPI。
  • LifeTime Deployment API v1
    OutSystemsインフラのアプリケーション、モジュール、環境、デプロイを管理できます。
  • LifeTime SDK
    LifeTimeとそのプラグインで使用されるコアレイアウトコンポーネントとAPI。
  • LifeTime Services API
    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から利用されるメソッドが使用するリクエストとレスポンスのコンテンツへのアクセスを可能にします。
  • SOAP Extensibility API
    拡張機能のSOAP接続やリクエスト/レスポンスメッセージの変更を可能にします。
  • Sanitization API
    信頼できないコンテンツ(エンドユーザーから収集されるコンテンツ)を含める必要があるHTML、JavaScript、SQLスニペットでコードインジェクションを防ぐためのメソッドを提供するAPI。
  • SAP Extensibility API
    OutSystems SAP Extensibility APIは、拡張機能によるSAPリモート機能への接続と呼び出しのカスタマイズを可能にします。
  • システムアクション
    リストオペレーションを含む、OutSystemsで利用可能なシステムアクション(サーバーアクションとクライアントアクションの両方)のリスト。
  • Text API
    結合、分割、正規表現を使用した検索と置換、日時表記のカスタム書式設定など、文字列操作のためのアクションを提供します。
  • Users API
    ユーザー、グループ、ロールを管理するためのAPI。