RDBMS拡張機能の追加、検索、比較または削除
POST
/rest/v1/admin
RDBMS拡張機能の追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるRDBMS拡張機能
ルート・スキーマ: RDBMS拡張機能のPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object RDBMS拡張機能のプロパティ
- base(optional): string
LDAP検索操作に使用する検索ベースDN。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls(optional): array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn(optional): string
作成、削除または比較するエントリのLDAP DN。注意: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
- filter(optional): string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType: string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
RESTメッセージ・タイプ - requiredAttributes(optional): array requiredAttributes
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope(optional): string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: RDBMS拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-connection-pool-provider(optional): string
デフォルト値:
universal-connection-pool
指定可能な値:[ "simple-pool", "universal-connection-pool" ]
この拡張機能に対して使用する接続プール実装。デフォルトでは、ユニバーサル接続プール(UCP)を使用します。注意: Simple_Poolを使用する場合、RDBMS拡張機能を複数のRDBMS WorkflowElement で共有できません。 - ds-cfg-connection-reuse-count(optional): integer(int32)
デフォルト値:
0
最大接続再使用数プロパティを設定します。このプロパティは、プールが接続を閉じて削除するまでに接続を再利用できる最大回数を指定します。この機能を有効にするには、値を0より大きくする必要があります。たとえば、指定した値が100の場合、接続がプールから100回再利用または流用されると、接続は閉じられてプールから削除されます。接続がプールに戻され、プロパティ値を超えると、接続は正常に閉じられます。デフォルトは0であり、これはこの機能が無効であることを意味します。 - ds-cfg-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-inactive-connection-timeout(optional): integer(int32)
デフォルト値:
0
非アクティブ接続タイムアウトを設定します。このタイムアウトによって、使用可能な接続が接続プールから削除されるまで、プールに存在している時間が決まります。有効値の範囲は、0からInteger.MAX_VALUEまでです。デフォルトは0です。値を0に設定すると、非アクティブ接続タイムアウト処理は無効になります。 - ds-cfg-initial-connection-pool-size(optional): integer(int32)
デフォルト値:
0
ConnectionPoolによって設定される初期の接続数。これは、プールの起動時に作成されてプールに配置される接続の数です。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは0です。 - ds-cfg-java-class: string
デフォルト値:
com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension
RDBMS拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-jdbc-connection-properties(optional): array ds-cfg-jdbc-connection-properties
接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
- ds-cfg-jdbc-driver-class: string
RDBMSベンダーにJDBCドライバの実装を提供するJavaクラスの完全修飾名を指定します。
- ds-cfg-jdbc-factory-properties(optional): boolean
デフォルト値:
false
JDBCドライバ関連接続プロパティを接続ファクトリ・プロパティとして設定する必要があるかどうかを指定するオプションのフラグ。値ペア。 - ds-cfg-jdbc-keystore-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStore
JDBCドライバのKeyStoreプロパティ名。 - ds-cfg-jdbc-keystore-pwd-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStorePassword
JDBCドライバのKeyStoreパスワード・プロパティ名。 - ds-cfg-jdbc-keystore-type-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStoreType
JDBCドライバのKeyStoreタイプ・プロパティ名。 - ds-cfg-jdbc-truststore-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStore
JDBCドライバのTrustStoreプロパティ名。 - ds-cfg-jdbc-truststore-pwd-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStorePassword
JDBCドライバのTrustStoreパスワード・プロパティ名。 - ds-cfg-jdbc-truststore-type-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStoreType
JDBCドライバのTrustStoreタイプ・プロパティ名。 - ds-cfg-jdbc-url: string
データベースに接続するためのJDBC URL。
- ds-cfg-login-timeout(optional): integer(int32)
デフォルト値:
0
データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。値が0のとき、デフォルトのシステム・タイムアウトが設定されている場合はその値になります。そうでない場合はタイムアウトしないことを意味します。 - ds-cfg-maximum-connection-pool-size(optional): integer(int32)
デフォルト値:
20
接続プールで設定できる最大接続数。最大接続数には、使用中の接続数と使用可能な接続数が含まれます。有効値の範囲は、1からInteger.MAX_VALUEまでです。デフォルトは20です。 - ds-cfg-minimum-connection-pool-size(optional): integer(int32)
デフォルト値:
10
接続プールによって設定される最小接続数を設定します。使用可能な接続数と使用中の接続数の合計が最小数未満の場合、接続はプールに戻されます。それ以外の場合、接続は閉じられます。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは10です。 - ds-cfg-rdbms-password(optional): string
デフォルト値:接続を取得するためのパスワード。
- ds-cfg-rdbms-username: string
接続を取得するためのユーザー名。
- ds-cfg-ssl-key-manager-provider(optional): string
使用する鍵マネージャ・プロバイダを指定します。RDBMS拡張機能。この鍵マネージャ・プロバイダは必須ではなく、リモート・サーバーがクライアント認証用に構成されている場合に使用できます。
- ds-cfg-ssl-trust-manager-provider(optional): string
使用する信頼マネージャ・プロバイダを指定します。RDBMS拡張機能。この信頼マネージャ・プロバイダは、リモート・バックエンドとセキュアな接続を確立する必要がある場合に必須です。
- ds-cfg-target-database(optional): string
指定可能な値:
[ "db2", "db2mainframe", "derby", "mysql", "mysql4", "oracle", "oracle10g", "oracle11", "oracle8i", "oracle9i", "postgresql", "sqlserver", "timesten" ]
バックエンド内のターゲット・データベースを指定します。 - ds-cfg-use-ssl(optional): boolean
デフォルト値:
false
データベースへのセキュアなJDBC接続を使用することを指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-jdbc-connection-properties
型:
array
接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
ソースを表示
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: RDBMS拡張機能のSuccessResponse
型:
ソースを表示
object
- compareResult(optional): boolean
LDAP比較操作の結果を示します。
- msgType: string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: RDBMS拡張機能のSearchResultEntry
型:
ソースを表示
object
- attributes: object RDBMS拡張機能のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: RDBMS拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-connection-pool-provider(optional): string
デフォルト値:
universal-connection-pool
指定可能な値:[ "simple-pool", "universal-connection-pool" ]
この拡張機能に対して使用する接続プール実装。デフォルトでは、ユニバーサル接続プール(UCP)を使用します。注意: Simple_Poolを使用する場合、RDBMS拡張機能を複数のRDBMS WorkflowElement で共有できません。 - ds-cfg-connection-reuse-count(optional): integer(int32)
デフォルト値:
0
最大接続再使用数プロパティを設定します。このプロパティは、プールが接続を閉じて削除するまでに接続を再利用できる最大回数を指定します。この機能を有効にするには、値を0より大きくする必要があります。たとえば、指定した値が100の場合、接続がプールから100回再利用または流用されると、接続は閉じられてプールから削除されます。接続がプールに戻され、プロパティ値を超えると、接続は正常に閉じられます。デフォルトは0であり、これはこの機能が無効であることを意味します。 - ds-cfg-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-inactive-connection-timeout(optional): integer(int32)
デフォルト値:
0
非アクティブ接続タイムアウトを設定します。このタイムアウトによって、使用可能な接続が接続プールから削除されるまで、プールに存在している時間が決まります。有効値の範囲は、0からInteger.MAX_VALUEまでです。デフォルトは0です。値を0に設定すると、非アクティブ接続タイムアウト処理は無効になります。 - ds-cfg-initial-connection-pool-size(optional): integer(int32)
デフォルト値:
0
ConnectionPoolによって設定される初期の接続数。これは、プールの起動時に作成されてプールに配置される接続の数です。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは0です。 - ds-cfg-java-class: string
デフォルト値:
com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension
RDBMS拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-jdbc-connection-properties(optional): array ds-cfg-jdbc-connection-properties
接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
- ds-cfg-jdbc-driver-class: string
RDBMSベンダーにJDBCドライバの実装を提供するJavaクラスの完全修飾名を指定します。
- ds-cfg-jdbc-factory-properties(optional): boolean
デフォルト値:
false
JDBCドライバ関連接続プロパティを接続ファクトリ・プロパティとして設定する必要があるかどうかを指定するオプションのフラグ。値ペア。 - ds-cfg-jdbc-keystore-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStore
JDBCドライバのKeyStoreプロパティ名。 - ds-cfg-jdbc-keystore-pwd-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStorePassword
JDBCドライバのKeyStoreパスワード・プロパティ名。 - ds-cfg-jdbc-keystore-type-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStoreType
JDBCドライバのKeyStoreタイプ・プロパティ名。 - ds-cfg-jdbc-truststore-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStore
JDBCドライバのTrustStoreプロパティ名。 - ds-cfg-jdbc-truststore-pwd-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStorePassword
JDBCドライバのTrustStoreパスワード・プロパティ名。 - ds-cfg-jdbc-truststore-type-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStoreType
JDBCドライバのTrustStoreタイプ・プロパティ名。 - ds-cfg-jdbc-url: string
データベースに接続するためのJDBC URL。
- ds-cfg-login-timeout(optional): integer(int32)
デフォルト値:
0
データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。値が0のとき、デフォルトのシステム・タイムアウトが設定されている場合はその値になります。そうでない場合はタイムアウトしないことを意味します。 - ds-cfg-maximum-connection-pool-size(optional): integer(int32)
デフォルト値:
20
接続プールで設定できる最大接続数。最大接続数には、使用中の接続数と使用可能な接続数が含まれます。有効値の範囲は、1からInteger.MAX_VALUEまでです。デフォルトは20です。 - ds-cfg-minimum-connection-pool-size(optional): integer(int32)
デフォルト値:
10
接続プールによって設定される最小接続数を設定します。使用可能な接続数と使用中の接続数の合計が最小数未満の場合、接続はプールに戻されます。それ以外の場合、接続は閉じられます。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは10です。 - ds-cfg-rdbms-password(optional): string
デフォルト値:接続を取得するためのパスワード。
- ds-cfg-rdbms-username: string
接続を取得するためのユーザー名。
- ds-cfg-ssl-key-manager-provider(optional): string
使用する鍵マネージャ・プロバイダを指定します。RDBMS拡張機能。この鍵マネージャ・プロバイダは必須ではなく、リモート・サーバーがクライアント認証用に構成されている場合に使用できます。
- ds-cfg-ssl-trust-manager-provider(optional): string
使用する信頼マネージャ・プロバイダを指定します。RDBMS拡張機能。この信頼マネージャ・プロバイダは、リモート・バックエンドとセキュアな接続を確立する必要がある場合に必須です。
- ds-cfg-target-database(optional): string
指定可能な値:
[ "db2", "db2mainframe", "derby", "mysql", "mysql4", "oracle", "oracle10g", "oracle11", "oracle8i", "oracle9i", "postgresql", "sqlserver", "timesten" ]
バックエンド内のターゲット・データベースを指定します。 - ds-cfg-use-ssl(optional): boolean
デフォルト値:
false
データベースへのセキュアなJDBC接続を使用することを指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-jdbc-connection-properties
型:
array
接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
ソースを表示
201レスポンス
作成済
ルート・スキーマ: RDBMS拡張機能のADDResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: RDBMS拡張機能のSearchResultEntry
型:
ソースを表示
object
- attributes: object RDBMS拡張機能のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: RDBMS拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-connection-pool-provider(optional): string
デフォルト値:
universal-connection-pool
指定可能な値:[ "simple-pool", "universal-connection-pool" ]
この拡張機能に対して使用する接続プール実装。デフォルトでは、ユニバーサル接続プール(UCP)を使用します。注意: Simple_Poolを使用する場合、RDBMS拡張機能を複数のRDBMS WorkflowElement で共有できません。 - ds-cfg-connection-reuse-count(optional): integer(int32)
デフォルト値:
0
最大接続再使用数プロパティを設定します。このプロパティは、プールが接続を閉じて削除するまでに接続を再利用できる最大回数を指定します。この機能を有効にするには、値を0より大きくする必要があります。たとえば、指定した値が100の場合、接続がプールから100回再利用または流用されると、接続は閉じられてプールから削除されます。接続がプールに戻され、プロパティ値を超えると、接続は正常に閉じられます。デフォルトは0であり、これはこの機能が無効であることを意味します。 - ds-cfg-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-inactive-connection-timeout(optional): integer(int32)
デフォルト値:
0
非アクティブ接続タイムアウトを設定します。このタイムアウトによって、使用可能な接続が接続プールから削除されるまで、プールに存在している時間が決まります。有効値の範囲は、0からInteger.MAX_VALUEまでです。デフォルトは0です。値を0に設定すると、非アクティブ接続タイムアウト処理は無効になります。 - ds-cfg-initial-connection-pool-size(optional): integer(int32)
デフォルト値:
0
ConnectionPoolによって設定される初期の接続数。これは、プールの起動時に作成されてプールに配置される接続の数です。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは0です。 - ds-cfg-java-class: string
デフォルト値:
com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension
RDBMS拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-jdbc-connection-properties(optional): array ds-cfg-jdbc-connection-properties
接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
- ds-cfg-jdbc-driver-class: string
RDBMSベンダーにJDBCドライバの実装を提供するJavaクラスの完全修飾名を指定します。
- ds-cfg-jdbc-factory-properties(optional): boolean
デフォルト値:
false
JDBCドライバ関連接続プロパティを接続ファクトリ・プロパティとして設定する必要があるかどうかを指定するオプションのフラグ。値ペア。 - ds-cfg-jdbc-keystore-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStore
JDBCドライバのKeyStoreプロパティ名。 - ds-cfg-jdbc-keystore-pwd-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStorePassword
JDBCドライバのKeyStoreパスワード・プロパティ名。 - ds-cfg-jdbc-keystore-type-prop-name(optional): string
デフォルト値:
javax.net.ssl.keyStoreType
JDBCドライバのKeyStoreタイプ・プロパティ名。 - ds-cfg-jdbc-truststore-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStore
JDBCドライバのTrustStoreプロパティ名。 - ds-cfg-jdbc-truststore-pwd-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStorePassword
JDBCドライバのTrustStoreパスワード・プロパティ名。 - ds-cfg-jdbc-truststore-type-prop-name(optional): string
デフォルト値:
javax.net.ssl.trustStoreType
JDBCドライバのTrustStoreタイプ・プロパティ名。 - ds-cfg-jdbc-url: string
データベースに接続するためのJDBC URL。
- ds-cfg-login-timeout(optional): integer(int32)
デフォルト値:
0
データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。値が0のとき、デフォルトのシステム・タイムアウトが設定されている場合はその値になります。そうでない場合はタイムアウトしないことを意味します。 - ds-cfg-maximum-connection-pool-size(optional): integer(int32)
デフォルト値:
20
接続プールで設定できる最大接続数。最大接続数には、使用中の接続数と使用可能な接続数が含まれます。有効値の範囲は、1からInteger.MAX_VALUEまでです。デフォルトは20です。 - ds-cfg-minimum-connection-pool-size(optional): integer(int32)
デフォルト値:
10
接続プールによって設定される最小接続数を設定します。使用可能な接続数と使用中の接続数の合計が最小数未満の場合、接続はプールに戻されます。それ以外の場合、接続は閉じられます。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは10です。 - ds-cfg-rdbms-password(optional): string
デフォルト値:接続を取得するためのパスワード。
- ds-cfg-rdbms-username: string
接続を取得するためのユーザー名。
- ds-cfg-ssl-key-manager-provider(optional): string
使用する鍵マネージャ・プロバイダを指定します。RDBMS拡張機能。この鍵マネージャ・プロバイダは必須ではなく、リモート・サーバーがクライアント認証用に構成されている場合に使用できます。
- ds-cfg-ssl-trust-manager-provider(optional): string
使用する信頼マネージャ・プロバイダを指定します。RDBMS拡張機能。この信頼マネージャ・プロバイダは、リモート・バックエンドとセキュアな接続を確立する必要がある場合に必須です。
- ds-cfg-target-database(optional): string
指定可能な値:
[ "db2", "db2mainframe", "derby", "mysql", "mysql4", "oracle", "oracle10g", "oracle11", "oracle8i", "oracle9i", "postgresql", "sqlserver", "timesten" ]
バックエンド内のターゲット・データベースを指定します。 - ds-cfg-use-ssl(optional): boolean
デフォルト値:
false
データベースへのセキュアなJDBC接続を使用することを指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-jdbc-connection-properties
型:
array
接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
ソースを表示
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ