ジャンプ先

• リクエスト
• レスポンス

DNによるRDBMS表の変更

PATCH

/rest/v1/admin/{dn}

DNによるRDBMS表の変更

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• dn(required): string
  変更するエントリのLDAP DN。

本文 ()

変更する必要があるRDBMS表

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations(必須): array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: controls

型: array

LDAP変更操作のためにサーバーに送信するLDAP制御。

ソースを表示

• 配列: 文字列

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: operations

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

ネストされたスキーマ: PatchOperation

型: object

ソースを表示

• attribute(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: values

型: array

更新する属性値。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: RDBMS表のPatchSuccessResponse

型: object

ソースを表示

• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/RDBMS Table SearchResultEntry"
            }
        }
    }
}

ネストされたスキーマ: searchResultEntries

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• 配列: オブジェクト RDBMS表のSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/RDBMS Table SearchResultEntry"
    }
}

ネストされたスキーマ: RDBMS表のSearchResultEntry

型: object

ソースを表示

• attributes(required): object RDBMS表のプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/RDBMS Table Properties"
        }
    }
}

ネストされたスキーマ: RDBMS表のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-cascade-delete-on-relation: boolean
  デフォルト値: false

  削除をカスケードするかどうか
• ds-cfg-db-schema-name: string
  RDBMSスキーマの名前
• ds-cfg-db-sequence-name: string
  この構成パラメータは、データベースでアイデンティティがサポートされない場合に、主キー・フィールド値を生成するデータベース順序を指定します。
• ds-cfg-db-table-name(required): string
  RDBMS表の名前
• ds-cfg-join-rule: string
  結合ルール
• ds-cfg-join-type: string
  指定可能な値: [ "many-to-one", "one-to-many", "one-to-one" ]

  この表と、結合条件によって暗黙的に示されている表の間の結合のタイプ
• ds-cfg-outer-join-required: boolean
  デフォルト値: true

  外部結合を実行する必要があるかどうか
• ds-cfg-primary-key-field(required): array ds-cfg-primary-key-field
  主キー・フィールド
• ds-cfg-primary-key-storability(required): boolean
  デフォルト値: true

  この構成パラメータは、この表の主キーにユーザー指定の値を含めることができるかどうかを決定します。Trueに設定された場合、エンドユーザーはこの列に値を挿入できます。自動生成される主キーの場合、このパラメータをfalseに設定します
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-primary-key-field",
        "ds-cfg-primary-key-storability",
        "ds-cfg-db-table-name"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-primary-key-field":{
            "description":"primary key field ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-join-type":{
            "description":"Type of join between this table and the table implied by the join condition ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one"
            ]
        },
        "ds-cfg-primary-key-storability":{
            "description":"This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to \"True\", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to \"false\" ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-sequence-name":{
            "description":"This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-join-rule":{
            "description":"join rules ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-db-table-name":{
            "description":"Name of the RDBMS Table ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-cascade-delete-on-relation":{
            "description":"whether deletes should be cascaded or not ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-schema-name":{
            "description":"Name of the RDBMS Schema ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-outer-join-required":{
            "description":"whether we should do an outer join or not ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-primary-key-field

型: array

主キー・フィールド

ソースを表示

• 配列: 文字列

{
    "description":"primary key field ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る