Jump to

• Request
• Response

Modify a File Based Debug Log Publisher by DN

patch

/rest/v1/admin/{dn}

Modify a File Based Debug Log Publisher by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be modified

Body ()

File Based Debug Log Publisher that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

• controls(optional): array controls
  LDAP controls to be sent to server for LDAP modify operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  The REST message type
• operations: 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

• [0]: 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

• [0]: 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: string
  The entry attribute to be modified.
• opType: string
  Allowed Values: [ "add", "delete", "replace", "increment" ]

  The type of the Patch Operation.
• values(optional): 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

• [0]: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : File Based Debug Log Publisher PatchSuccessResponse

Type: object

Show Source

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

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: 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/File Based Debug Log Publisher SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object File Based Debug Log Publisher SearchResultEntry

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

Nested Schema : File Based Debug Log Publisher SearchResultEntry

Type: object

Show Source

• attributes: object File Based Debug Log Publisher Properties
• dn: 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/File Based Debug Log Publisher Properties"
        }
    }
}

Nested Schema : File Based Debug Log Publisher Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-append(optional): boolean
  Default Value: true

  Specifies whether to append to existing log files.
• ds-cfg-asynchronous: boolean
  Default Value: false

  Indicates whether the File Based Debug Log Publisher will publish records asynchronously.
• ds-cfg-auto-flush(optional): boolean
  Default Value: true

  Specifies whether to flush the writer after every log record.
• ds-cfg-buffer-size(optional): string
  Default Value: 64kb

  Specifies the log file buffer size.
• ds-cfg-default-debug-category(optional): array ds-cfg-default-debug-category
  The debug message categories to be logged when none of the defined targets match the message.
• ds-cfg-default-debug-level: string
  Default Value: error

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

  The lowest severity level of debug messages to log when none of the defined targets match the message.
• ds-cfg-default-include-throwable-cause(optional): boolean
  Default Value: true

  Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default.
• ds-cfg-default-omit-method-entry-arguments(optional): boolean
  Default Value: false

  Indicates whether to include method arguments in debug messages logged by default.
• ds-cfg-default-omit-method-return-value(optional): boolean
  Default Value: false

  Indicates whether to include the return value in debug messages logged by default.
• ds-cfg-default-throwable-stack-frames(optional): integer(int32)
  Default Value: 2147483647

  Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages.
• ds-cfg-enabled: boolean
  Indicates whether the Log Publisher is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.loggers.debug.TextDebugLogPublisher

  The fully-qualified name of the Java class that provides the File Based Debug Log Publisher implementation.
• ds-cfg-log-file: string
  The file name to use for the log files generated by the File Based Debug Log Publisher .
• ds-cfg-log-file-permissions: string
  Default Value: 640

  The UNIX permissions of the log files created by this File Based Debug Log Publisher .
• ds-cfg-log-file-use-local-time(optional): boolean
  Default Value: false

  Specifies whether to use local time or GMT for the name of the rotated files.
• ds-cfg-queue-size(optional): integer(int32)
  Default Value: 5000

  The maximum number of log records that can be stored in the asynchronous queue.
• ds-cfg-retention-policy(optional): array ds-cfg-retention-policy
  The retention policy to use for the File Based Debug Log Publisher .
• ds-cfg-rotation-policy(optional): array ds-cfg-rotation-policy
  The rotation policy to use for the File Based Debug Log Publisher .
• ds-cfg-time-interval(optional): string
  Default Value: 5s

  Specifies the interval at which to check whether the log files need to be rotated.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-default-debug-level",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "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-java-class":{
            "description":"The fully-qualified name of the Java class that provides the File Based Debug Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.debug.TextDebugLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-default-omit-method-entry-arguments":{
            "description":"Indicates whether to include method arguments in debug messages logged by default. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based Debug Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-default-debug-level":{
            "description":"The lowest severity level of debug messages to log when none of the defined targets match the message. ",
            "readOnly":false,
            "default":"error",
            "type":"string",
            "enum":[
                "all",
                "disabled",
                "error",
                "info",
                "verbose",
                "warning"
            ]
        },
        "ds-cfg-default-omit-method-return-value":{
            "description":"Indicates whether to include the return value in debug messages logged by default. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-default-throwable-stack-frames":{
            "description":"Indicates the number of stack frames to include in the stack trace for method entry and exception thrown messages. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-default-debug-category":{
            "description":"The debug message categories to be logged when none of the defined targets match the message. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "caught",
                "constructor",
                "data",
                "database-access",
                "enter",
                "exit",
                "message",
                "protocol",
                "thrown"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Debug Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based Debug Log Publisher . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Debug Log Publisher . ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based Debug Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-default-include-throwable-cause":{
            "description":"Indicates whether to include the cause of exceptions in exception thrown and caught messages logged by default. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-default-debug-category

Type: array

The debug message categories to be logged when none of the defined targets match the message.

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

Show Source

• [0]: string

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

Nested Schema : ds-cfg-retention-policy

Type: array

The retention policy to use for the File Based Debug Log Publisher .

Show Source

• [0]: string

{
    "description":"The retention policy to use for the File Based Debug Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-rotation-policy

Type: array

The rotation policy to use for the File Based Debug Log Publisher .

Show Source

• [0]: string

{
    "description":"The rotation policy to use for the File Based Debug Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

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

400 Response

ERROR

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: 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."
        }
    }
}

Back to Top