REST API for Oracle Unified Directory Administration

Modify a Debug Target by DN

patch

/rest/v1/admin/{dn}

Modify a Debug Target by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Debug Target 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 : Debug Target 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/Debug Target SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Debug Target SearchResultEntry

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

Nested Schema : Debug Target SearchResultEntry

Type: object

Show Source

attributes(required): object Debug Target 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/Debug Target Properties"
        }
    }
}

Nested Schema : Debug Target Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-debug-category: array ds-cfg-debug-category

Specifies the debug message categories to be logged.
ds-cfg-debug-level(required): string

Allowed Values: [ "all", "disabled", "error", "info", "verbose", "warning" ]

Specifies the lowest severity level of debug messages to log.
ds-cfg-debug-scope: string

Read Only: true

Specifies the fully-qualified Oracle Unified Directory Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp).
ds-cfg-include-throwable-cause: boolean

Default Value: false

Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages.
ds-cfg-omit-method-entry-arguments: boolean

Default Value: false

Specifies the property to indicate whether to include method arguments in debug messages.
ds-cfg-omit-method-return-value: boolean

Default Value: false

Specifies the property to indicate whether to include the return value in debug messages.
ds-cfg-throwable-stack-frames: integer(int32)

Default Value: 0

Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-debug-level"
    ],
    "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-debug-scope":{
            "description":"Specifies the fully-qualified Oracle Unified Directory Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp). ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-debug-level":{
            "description":"Specifies the lowest severity level of debug messages to log. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "all",
                "disabled",
                "error",
                "info",
                "verbose",
                "warning"
            ]
        },
        "ds-cfg-omit-method-entry-arguments":{
            "description":"Specifies the property to indicate whether to include method arguments in debug messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-throwable-stack-frames":{
            "description":"Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-debug-category":{
            "description":"Specifies the debug message categories to be logged. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "caught",
                "constructor",
                "data",
                "database-access",
                "enter",
                "exit",
                "message",
                "protocol",
                "thrown"
            ]
        },
        "ds-cfg-omit-method-return-value":{
            "description":"Specifies the property to indicate whether to include the return value in debug messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-include-throwable-cause":{
            "description":"Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-debug-category

Type: array

Specifies the debug message categories to be logged.

Allowed Values:

[
    "caught",
    "constructor",
    "data",
    "database-access",
    "enter",
    "exit",
    "message",
    "protocol",
    "thrown"
]

Show Source

Array of: string

{
    "description":"Specifies the debug message categories to be logged. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "caught",
        "constructor",
        "data",
        "database-access",
        "enter",
        "exit",
        "message",
        "protocol",
        "thrown"
    ]
}

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