ジャンプ先

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

DNによるグローバル索引の変更

PATCH

/rest/v1/admin/{dn}

DNによるグローバル索引の変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるグローバル索引

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls(optional): array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType: 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制御。

ソースを表示

• [0]: string

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

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

型: array

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

ソースを表示

• [0]: object PatchOperation

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

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

型: object

ソースを表示

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

  パッチ操作のタイプ。
• values(optional): 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

更新する属性値。

ソースを表示

• [0]: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: グローバル索引のPatchSuccessResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults: 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/Global Index SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object グローバル索引のSearchResultEntry

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

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

型: object

ソースを表示

• attributes: object グローバル索引のプロパティ
• dn: string
  作成するエントリのLDAP DN。

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

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

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-db-checkpointer-bytes-interval(optional): string
  デフォルト値: 20mb

  強制的にチェックポイントを実行させられる前にデータベースに書き込むことのできる最大バイト数を指定します。
• ds-cfg-db-checkpointer-wakeup-interval(optional): string
  デフォルト値: 30s

  チェックポイント間の最長時間を指定します。
• ds-cfg-db-cleaner-min-utilization(optional): integer(int32)
  デフォルト値: 50

  データベース消去プログラムがデータベース・ログ・ファイルに保持する実データの最小パーセンテージを指定します。
• ds-cfg-db-directory: string
  デフォルト値: catalogs

  このグローバル索引のデータを含むBerkeley DB Java Editionデータベース・ファイルの保持に使用されるファイル・システム・ディレクトリのパスを指定します。
• ds-cfg-db-directory-permissions(optional): string
  デフォルト値: 700

  グローバル索引のデータベース・ファイルを含むディレクトリに適用する権限を指定します。
• ds-cfg-db-log-file-max(optional): string
  デフォルト値: 10mb

  データベース・ログ・ファイルの最大サイズを指定します。
• ds-cfg-db-num-cleaner-threads(optional): integer(int32)
  データベース・ログ・ファイルを望ましい使用率またはそれに近い使用率に維持するために、バックエンドが保持するスレッドの数を指定します。
• ds-cfg-db-num-lock-tables(optional): integer(int32)
  基礎となるデータベースで使用されるロック表の数を指定します。
• ds-cfg-db-txn-no-sync(optional): boolean
  デフォルト値: false

  データベース書込みをすぐにディスクに書き込まないで主に内部バッファに書き込むかどうかを示します。
• ds-cfg-db-txn-write-no-sync(optional): boolean
  デフォルト値: true

  データベースの内容がディスクに書き込まれるときにデータを同期的にフラッシュするかどうかを示します。
• ds-cfg-deleted-entry-retention-timeout(optional): string
  デフォルト値: 500ms

  削除されたエントリをシステムに残しておく期間を指定します。
• ds-cfg-global-index-attribute(optional): string
  読取り専用: true

  索引を作成する属性を指定します。
• ds-cfg-global-index-catalogs-shared-cache(optional): string
  読取り専用: true

  デフォルト値: global-index-catalogs-shared-cache

  該当するJVMインスタンス内のすべてのグローバル索引によって使用されるキャッシュ。
• ds-cfg-je-property(optional): array ds-cfg-je-property
  このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-db-directory"
    ],
    "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-db-log-file-max":{
            "description":"Specifies the maximum size for a database log file. ",
            "readOnly":false,
            "default":"10mb",
            "type":"string"
        },
        "ds-cfg-db-txn-write-no-sync":{
            "description":"Indicates whether the database should synchronously flush data as it is written to disk. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-directory-permissions":{
            "description":"Specifies the permissions that should be applied to the directory containing the Global Index database files. ",
            "readOnly":false,
            "default":"700",
            "type":"string"
        },
        "ds-cfg-db-checkpointer-bytes-interval":{
            "description":"Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint. ",
            "readOnly":false,
            "default":"20mb",
            "type":"string"
        },
        "ds-cfg-db-txn-no-sync":{
            "description":"Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-directory":{
            "description":"Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this Global Index. ",
            "readOnly":false,
            "default":"catalogs",
            "type":"string"
        },
        "ds-cfg-je-property":{
            "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-deleted-entry-retention-timeout":{
            "description":"Specifies how long a deleted entry is kept in the system. ",
            "readOnly":false,
            "default":"500ms",
            "type":"string"
        },
        "ds-cfg-db-cleaner-min-utilization":{
            "description":"Specifies the minimum percentage of \"live\" data that the database cleaner attempts to keep in database log files. ",
            "readOnly":false,
            "default":50,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-num-cleaner-threads":{
            "description":"Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-checkpointer-wakeup-interval":{
            "description":"Specifies the maximum length of time that may pass between checkpoints. ",
            "readOnly":false,
            "default":"30s",
            "type":"string"
        },
        "ds-cfg-global-index-attribute":{
            "description":"Specifies the attribute to index. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-db-num-lock-tables":{
            "description":"Specifies the number of lock tables that are used by the underlying database. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-global-index-catalogs-shared-cache":{
            "description":"The cache used by all of the global indexes in that JVM instance. ",
            "readOnly":true,
            "default":"global-index-catalogs-shared-cache",
            "type":"string"
        }
    }
}

ネストされたスキーマ: ds-cfg-je-property

型: array

このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode(optional): integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message: string
  操作に対して返されるエラー・メッセージ。
• msgType: 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."
        }
    }
}

先頭に戻る