REST API for Oracle Unified Directory Administration

Modify a High Etime File Based Access Log Publisher by DN

patch

/rest/v1/admin/{dn}

Modify a High Etime File Based Access Log Publisher by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

High Etime File Based Access Log Publisher 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 : High Etime File Based Access Log Publisher 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/High Etime File Based Access Log Publisher SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object High Etime File Based Access Log Publisher SearchResultEntry

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

Nested Schema : High Etime File Based Access Log Publisher SearchResultEntry

Type: object

Show Source

attributes(required): object High Etime File Based Access Log Publisher 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/High Etime File Based Access Log Publisher Properties"
        }
    }
}

Nested Schema : High Etime File Based Access Log Publisher Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-append: boolean

Default Value: true

Specifies whether to append to existing log files.
ds-cfg-asynchronous(required): boolean

Default Value: true

Indicates whether the File Based Access Log Publisher will publish records asynchronously.
ds-cfg-auto-flush: boolean

Default Value: true

Specifies whether to flush the writer after every log record.
ds-cfg-buffer-size: string

Default Value: 64kb

Specifies the log file buffer size.
ds-cfg-enabled(required): boolean

Indicates whether the Log Publisher is enabled for use.
ds-cfg-java-class(required): string

Default Value: org.opends.server.loggers.HighEtimeAccessLogPublisher

The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation.
ds-cfg-log-controls: boolean

Default Value: false

Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
ds-cfg-log-file(required): string

The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.
ds-cfg-log-file-permissions(required): string

Default Value: 640

The UNIX permissions of the log files created by this File Based Access Log Publisher.
ds-cfg-log-file-use-local-time: boolean

Default Value: false

Specifies whether to use local time or GMT for the name of the rotated files.
ds-cfg-log-high-etime-limit(required): string

Default Value: 10 milliseconds

Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher.
ds-cfg-log-qtime: boolean

Default Value: false

Logs the time spent in preprocessing queue for an operation.
ds-cfg-operations-to-log: array ds-cfg-operations-to-log

Indicates which operations has to be logged.
ds-cfg-queue-size: integer(int32)

Default Value: 5000

The maximum number of log records that can be stored in the asynchronous queue.
ds-cfg-retention-policy: array ds-cfg-retention-policy

The retention policy to use for the File Based Access Log Publisher .
ds-cfg-rotation-policy: array ds-cfg-rotation-policy

The rotation policy to use for the File Based Access Log Publisher .
ds-cfg-time-interval: string

Default Value: 5s

Specifies the interval at which to check whether the log files need to be rotated.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-log-high-etime-limit",
        "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 High Etime File Based Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.HighEtimeAccessLogPublisher",
            "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-log-high-etime-limit":{
            "description":"Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher. ",
            "readOnly":false,
            "default":"10 milliseconds",
            "type":"string"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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-log-qtime":{
            "description":"Logs the time spent in preprocessing queue for an operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing",
                "synchronization"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "internal",
                "synchronization",
                "user"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "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 Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Access 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 Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-operations-to-log

Type: array

Indicates which operations has to be logged.

Default Value:

[
    "administration",
    "user",
    "adminbrowsing",
    "synchronization"
]

Allowed Values:

[
    "adminbrowsing",
    "administration",
    "all",
    "internal",
    "synchronization",
    "user"
]

Show Source

Array of: string

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing",
        "synchronization"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "internal",
        "synchronization",
        "user"
    ]
}

Nested Schema : ds-cfg-retention-policy

Type: array

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

Show Source

Array of: string

{
    "description":"The retention policy to use for the File Based Access 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 Access Log Publisher .

Show Source

Array of: string

{
    "description":"The rotation policy to use for the File Based Access Log Publisher . ",
    "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."
        }
    }
}