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-cascade-delete-on-relation(optional): boolean
デフォルト値:
false
削除をカスケードするかどうか - ds-cfg-db-sequence-name(optional): string
この構成パラメータは、データベースでアイデンティティがサポートされない場合に、主キー・フィールド値を生成するデータベース順序を指定します。
- ds-cfg-db-table-name: string
RDBMS表の名前
- ds-cfg-join-rule(optional): string
結合ルール
- ds-cfg-join-type(optional): string
指定可能な値:
[ "many-to-one", "one-to-many", "one-to-one" ]
この表と、結合条件によって暗黙的に示されている表の間の結合のタイプ - ds-cfg-outer-join-required(optional): boolean
デフォルト値:
true
外部結合を実行する必要があるかどうか - ds-cfg-primary-key-field: array ds-cfg-primary-key-field
主キー・フィールド
- ds-cfg-primary-key-storability: boolean
デフォルト値:
true
この構成パラメータは、この表の主キーにユーザー指定の値を含めることができるかどうかを決定します。Trueに設定された場合、エンドユーザーはこの列に値を挿入できます。自動生成される主キーの場合、このパラメータをfalseに設定します - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
レスポンス
サポートされているメディア・タイプ
- 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-cascade-delete-on-relation(optional): boolean
デフォルト値:
false
削除をカスケードするかどうか - ds-cfg-db-sequence-name(optional): string
この構成パラメータは、データベースでアイデンティティがサポートされない場合に、主キー・フィールド値を生成するデータベース順序を指定します。
- ds-cfg-db-table-name: string
RDBMS表の名前
- ds-cfg-join-rule(optional): string
結合ルール
- ds-cfg-join-type(optional): string
指定可能な値:
[ "many-to-one", "one-to-many", "one-to-one" ]
この表と、結合条件によって暗黙的に示されている表の間の結合のタイプ - ds-cfg-outer-join-required(optional): boolean
デフォルト値:
true
外部結合を実行する必要があるかどうか - ds-cfg-primary-key-field: array ds-cfg-primary-key-field
主キー・フィールド
- ds-cfg-primary-key-storability: boolean
デフォルト値:
true
この構成パラメータは、この表の主キーにユーザー指定の値を含めることができるかどうかを決定します。Trueに設定された場合、エンドユーザーはこの列に値を挿入できます。自動生成される主キーの場合、このパラメータをfalseに設定します - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
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-cascade-delete-on-relation(optional): boolean
デフォルト値:
false
削除をカスケードするかどうか - ds-cfg-db-sequence-name(optional): string
この構成パラメータは、データベースでアイデンティティがサポートされない場合に、主キー・フィールド値を生成するデータベース順序を指定します。
- ds-cfg-db-table-name: string
RDBMS表の名前
- ds-cfg-join-rule(optional): string
結合ルール
- ds-cfg-join-type(optional): string
指定可能な値:
[ "many-to-one", "one-to-many", "one-to-one" ]
この表と、結合条件によって暗黙的に示されている表の間の結合のタイプ - ds-cfg-outer-join-required(optional): boolean
デフォルト値:
true
外部結合を実行する必要があるかどうか - ds-cfg-primary-key-field: array ds-cfg-primary-key-field
主キー・フィールド
- ds-cfg-primary-key-storability: boolean
デフォルト値:
true
この構成パラメータは、この表の主キーにユーザー指定の値を含めることができるかどうかを決定します。Trueに設定された場合、エンドユーザーはこの列に値を挿入できます。自動生成される主キーの場合、このパラメータをfalseに設定します - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ