接続用のREST API

接続リポジトリの項目は、ZIPファイル (ファイル拡張子は.conninfo)です。これらのファイルには、例えば、JDBCドライバーのJARファイルや、接続内で利用可能なパラメータのセットを定義する設定などのデータが含まれています。

.conninfoファイル (ZIPファイル) と .connmdファイル (JSONメタデータファイル)をREST API経由でアップロードすることが可能です。以下のセクションでは、これを実現する方法の概要のみを説明します。

有効なidTokenをリクエストする方法については、一般的なREST APIの記事の指示に従ってください。

カスタム.conninfoをアップロードするには、ロケーション$LOCATIONにPOSTリクエストを発行し、エンドポイント$RMServerHost/api/rest/resources$LOCATIONにいくつかの特定のHTTPヘッダーを追加する必要があります。

$LOCATIONは、接続を保存する絶対的なリポジトリの場所です。接続は事前に定義された接続フォルダの/Connections内にしか保存できないので、$LOCATION = /Connections/myConnectionはアップロードされた.conninfo ZIPファイルを接続フォルダ内にmyConnectionという名前で保存します。ベースエンドポイントのURLの後にダブルスラッシュを追加しないでください。
ヘッダーのContent-Typeはapplication/vnd.rapidminer.conninfo+zipに設定する必要があります。
ヘッダーのIOObject-Classは接続タイプに設定する必要があります。例えば、データベース接続の場合はjdbc_connectors:jdbcに設定する必要があります。
.conninfo ZIPファイルは、バイナリリクエストとして接続をアップロードするマシンファイルシステムから参照されなければなりません。

REST APIを介して接続をアップロードするためのcURLサンプルリクエスト


curl -X POST $RMServerHost/api/rest/resources/Connections/myConnection \
  -H 'Authorization: Bearer $idToken' \
  -H 'Content-Type: application/vnd.rapidminer.conninfo+zip' \
  -H 'IOObject-Class: jdbc_connectors:jdbc' \
  --data-binary '@/path/to/myConnection.conninfo'

オプションとして、生成された接続項目のメタデータを .conninfoファイルとは別にアップロードすることも可能です。

そのためには、Content-Typeをapplication/vnd.rapidminer.conmd+jsonに調整し、IOObject-Classヘッダーを省略します。.connmdメタデータファイルをバイナリとして参照する必要があります。

REST APIを介して接続メタデータをアップロードするためのcURLサンプルリクエスト


curl -X POST $RMServerHost/api/rest/resources/Connections/myConnection \
  -H 'Authorization: Bearer $idToken' \
  -H 'Content-Type: application/vnd.rapidminer.conmd+json' \
  --data-binary '@/path/to/myConnection.connmd'

また、–data-binaryパラメータでファイルシステム上の既存のファイルを参照する代わりに、cURLの–dataパラメータを使用して、JSONメタデータを直接挿入することもできます。