REST API の概要

REST API は、HTTP を使用して、Java™ API 関数のサブセットをクライアントおよび Web ブラウザーに公開します。 REST リソースを使用して、HTTP 呼び出しをサポートする任意のオペレーティング・システムおよび言語のアプリケーションを開発できます。

REST リソースは、TADDM 機能を公開します。これらの機能では、クラス名、グローバル固有 ID (GUID)、またはモデル照会言語 (MQL) 照会を使用して、モデル・オブジェクトを照会できます。 また、モデル・オブジェクトを作成、削除、更新したり、TADDM ディスカバリー・プロセスを管理したりすることもできます。 これらの機能はすべて、標準 HTTP インターフェースを使用し、JSON 形式または XML 形式の入出力データをサポートします。

REST サーバー・コンポーネントは、TADDM サーバーの $COLLATION_HOME/deploy-tomcat ディレクトリー (TADDM 7.3.0) または $COLLATION_HOME/apps ディレクトリー (TADDM 7.3.0.1 以降) にインストールされ、TADDM サーバーの始動時に自動的に開始します。 REST サービスは、TADDM 管理 Web インターフェースが使用しているのと同じ TCP/IP ポートを介して使用可能です。 (デフォルト・ポートは、HTTP の場合は 9430、HTTPS の場合は 9431 です。)

REST API は、HTTP 基本認証を適用し、ユーザー ID とパスワードを MIME Base64 エンコードを使用して送信します。 各要求はステートレスであるため、REST API への呼び出しのそれぞれに、HTTP 許可ヘッダーが組み込まれている必要があります。 セキュア接続には、HTTPS 接続を使用してください。

http://resource_url?parameter=value&parameter=value...

無効なパラメーター値を指定すると、TADDM サーバーはその値を無視し、デフォルト値を判別できる場合は、デフォルト値を使用します。 (例えば、fetchSize=-2 を指定すると、サーバーは fetchSize の値に 1 を使用します)。 デフォルト値を判別できない場合、要求は失敗します。