ジャンプ先

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

DNによるローカルDB索引の変更

PATCH

/rest/v1/admin/{dn}

DNによるローカルDB索引の変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるローカルDB索引

ルート・スキーマ: 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

本文 ()

ルート・スキーマ: ローカルDB索引の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/Local DB Index SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト ローカルDB索引のSearchResultEntry

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

ネストされたスキーマ: ローカルDB索引のSearchResultEntry

型: object

ソースを表示

• attributes(required): object ローカルDB索引のプロパティ
• 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/Local DB Index Properties"
        }
    }
}

ネストされたスキーマ: ローカルDB索引のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-attribute: string
  読取り専用: true

  索引が維持される属性の名前を指定します。
• ds-cfg-index-entry-limit: integer(int32)
  指定された索引キーが維持されなくなる前に、この索引キーを照合できるエントリの最大数を指定します。
• ds-cfg-index-extensible-matching-rule: array ds-cfg-index-extensible-matching-rule
  拡張可能な索引の拡張可能な一致ルール。
• ds-cfg-index-type(required): array ds-cfg-index-type
  関連付けられた属性に対して実行する索引作成のタイプを指定します。
• ds-cfg-purging: boolean
  デフォルト値: false

  索引順の値をパージするかどうかを示します。
• ds-cfg-substring-length: integer(int32)
  デフォルト値: 6

  部分文字列索引の部分文字列の長さ。
• ds-cfg-tombstones-included: boolean
  デフォルト値: false

  その索引がツームストン・エントリに対しても保持されるかどうかを示します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":"6",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-index-extensible-matching-rule

型: array

拡張可能な索引の拡張可能な一致ルール。

ソースを表示

• 配列: 文字列

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-index-type

型: array

関連付けられた属性に対して実行する索引作成のタイプを指定します。

指定可能な値: [ "approximate", "equality", "extensible", "ordering", "presence", "substring" ]

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

ネストされたスキーマ: 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."
        }
    }
}

先頭に戻る