REST API for Oracle Unified Directory Administration

Modify a Local DB Index by DN

patch

/rest/v1/admin/{dn}

Modify a Local DB Index by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Local DB 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 : Local DB 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/Local DB Index SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Local DB Index SearchResultEntry

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

Nested Schema : Local DB Index SearchResultEntry

Type: object

Show Source

attributes(required): object Local DB 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/Local DB Index Properties"
        }
    }
}

Nested Schema : Local DB Index Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-attribute: string

Read Only: true

Specifies the name of the attribute for which the index is to be maintained.
ds-cfg-index-entry-limit: integer(int32)

Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained.
ds-cfg-index-extensible-matching-rule: array ds-cfg-index-extensible-matching-rule

The extensible matching rule in an extensible index.
ds-cfg-index-type(required): array ds-cfg-index-type

Specifies the type(s) of indexing that should be performed for the associated attribute.
ds-cfg-purging: boolean

Default Value: false

Indicates whether this index older values should be purged.
ds-cfg-substring-length: integer(int32)

Default Value: 6

The length of substrings in a substring index.
ds-cfg-tombstones-included: boolean

Default Value: false

Indicates whether this index is maintained for tombstone entries as well.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

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

Nested Schema : ds-cfg-index-extensible-matching-rule

Type: array

The extensible matching rule in an extensible index.

Show Source

Array of: string

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

Nested Schema : ds-cfg-index-type

Type: array

Specifies the type(s) of indexing that should be performed for the associated attribute.

Allowed Values:

[
    "approximate",
    "equality",
    "extensible",
    "ordering",
    "presence",
    "substring"
]

Show Source

Array of: string

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

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