REST API for Oracle Unified Directory Administration

Modify a Global Index by DN

patch

/rest/v1/admin/{dn}

Modify a Global Index by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Global Index that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

controls: array controls

LDAP controls to be sent to server for LDAP modify operation.
msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

The REST message type
operations(required): array operations

Modifications (Patch operations) to be performed on the entry.

{
    "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"
            }
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for LDAP modify operation.

Show Source

Array of: string

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

Nested Schema : operations

Type: array

Modifications (Patch operations) to be performed on the entry.

Show Source

Array of: object PatchOperation

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

Nested Schema : PatchOperation

Type: object

Show Source

attribute(required): string

The entry attribute to be modified.
opType(required): string

Allowed Values: [ "add", "delete", "replace", "increment" ]

The type of the Patch Operation.
values: array values

The attribute values to be updated.

{
    "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"
            }
        }
    }
}

Nested Schema : values

Type: array

The attribute values to be updated.

Show Source

Array of: string

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

Response

Supported Media Types

application/json

200 Response

Root Schema : Global Index PatchSuccessResponse

Type: object

Show Source

msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

The REST message type
searchResultEntries(required): array searchResultEntries

Number of search result entries returned after the LDAP operation.
totalResults(required): integer(int32)

Specifies the number of entries created, and returned.

{
    "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"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Global Index SearchResultEntry

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

Nested Schema : Global Index SearchResultEntry

Type: object

Show Source

attributes(required): object Global Index Properties
dn(required): string

LDAP DN of the entry to be created

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

Nested Schema : Global Index Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-db-checkpointer-bytes-interval: string

Default Value: 20mb

Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint.
ds-cfg-db-checkpointer-wakeup-interval: string

Default Value: 30s

Specifies the maximum length of time that may pass between checkpoints.
ds-cfg-db-cleaner-min-utilization: integer(int32)

Default Value: 50

Specifies the minimum percentage of "live" data that the database cleaner attempts to keep in database log files.
ds-cfg-db-directory(required): string

Default Value: catalogs

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.
ds-cfg-db-directory-permissions: string

Default Value: 700

Specifies the permissions that should be applied to the directory containing the Global Index database files.
ds-cfg-db-log-file-max: string

Default Value: 10mb

Specifies the maximum size for a database log file.
ds-cfg-db-num-cleaner-threads: integer(int32)

Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization.
ds-cfg-db-num-lock-tables: integer(int32)

Specifies the number of lock tables that are used by the underlying database.
ds-cfg-db-txn-no-sync: boolean

Default Value: false

Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk.
ds-cfg-db-txn-write-no-sync: boolean

Default Value: true

Indicates whether the database should synchronously flush data as it is written to disk.
ds-cfg-deleted-entry-retention-timeout: string

Default Value: 500ms

Specifies how long a deleted entry is kept in the system.
ds-cfg-global-index-attribute: string

Read Only: true

Specifies the attribute to index.
ds-cfg-global-index-catalogs-shared-cache: string

Read Only: true

Default Value: global-index-catalogs-shared-cache

The cache used by all of the global indexes in that JVM instance.
ds-cfg-je-property: array ds-cfg-je-property

Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "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"
        }
    }
}

Nested Schema : ds-cfg-je-property

Type: array

Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.

Show Source

Array of: 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"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

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

400 Response

ERROR

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

Show Source

ldapErrorCode: integer(int32)

Specifies the LDAP error code returned for the operation.
message(required): string

Error message returned returned for the operation.
msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

The REST message type

{
    "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."
        }
    }
}