Jump to

• Request
• Response

Modify a DB Local Backend Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a DB Local Backend Workflow Element by DN

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

DB Local Backend Workflow Element 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

• 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: 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

• Array of: 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 : DB Local Backend Workflow Element 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/DB Local Backend Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object DB Local Backend Workflow Element SearchResultEntry

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

Nested Schema : DB Local Backend Workflow Element SearchResultEntry

Type: object

Show Source

• attributes: object DB Local Backend Workflow Element 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/DB Local Backend Workflow Element Properties"
        }
    }
}

Nested Schema : DB Local Backend Workflow Element Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allow-undefined-attribute-search-filter(optional): boolean
  Default Value: false

  Indicates whether an undefined attribute should be allowed in the search filter for processing.
• ds-cfg-base-dn: array ds-cfg-base-dn
  Specifies the base DN(s) for the data that the backend handles.
• ds-cfg-cold-attribute(optional): array ds-cfg-cold-attribute
  Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage.
• ds-cfg-compact-attribute-values-using-tokens(optional): array ds-cfg-compact-attribute-values-using-tokens
  Indicates the list of attributes that the server should compact using token instead of values.
• ds-cfg-compact-encoding(optional): boolean
  Default Value: true

  Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets.
• ds-cfg-db-cache-mode(optional): string
  Default Value: default

  Allowed Values: [ "default", "evict-bin", "evict-ln", "keep-hot", "make-cold", "unchanged" ]

  Specifies the in-memory cache mode used for operations performed.
• ds-cfg-db-cache-percent(optional): integer(int32)
  Specifies the percentage of JVM memory to allocate to the database cache.
• ds-cfg-db-cache-size(optional): string
  Default Value: 0 MB

  The amount of JVM memory to allocate to the database cache.
• ds-cfg-db-checkpointer-bytes-interval(optional): 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(optional): string
  Default Value: 30s

  Specifies the maximum length of time that may pass between checkpoints.
• ds-cfg-db-cleaner-min-utilization(optional): 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: string
  Default Value: db

  Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this backend.
• ds-cfg-db-directory-permissions(optional): string
  Default Value: 700

  Specifies the permissions that should be applied to the directory containing the server database files.
• ds-cfg-db-evictor-lru-only(optional): boolean
  Default Value: true

  Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first).
• ds-cfg-db-evictor-nodes-per-scan(optional): integer(int32)
  Default Value: 10

  Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information.
• ds-cfg-db-log-file-max(optional): string
  Default Value: 100mb

  Specifies the maximum size for a database log file.
• ds-cfg-db-logging-file-handler-on(optional): boolean
  Default Value: true

  Indicates whether the database should maintain a je.info file in the same directory as the database log directory.
• ds-cfg-db-logging-level(optional): string
  Default Value: CONFIG

  Specifies the log level that should be used by the database when it is writing information into the je.info file.
• ds-cfg-db-num-cleaner-threads(optional): 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(optional): integer(int32)
  Specifies the number of lock tables that are used by the underlying database.
• ds-cfg-db-run-cleaner(optional): boolean
  Default Value: true

  Indicates whether the database cleaner threads should be enabled.
• ds-cfg-db-txn-durability(optional): string
  Default Value: write-to-filesystem

  Allowed Values: [ "write-to-cache", "write-to-disk", "write-to-filesystem" ]

  Specifies the durability of database transactions.
• ds-cfg-disk-full-threshold(optional): string
  Default Value: 20 megabytes

  Full disk threshold to limit database updates.
• ds-cfg-disk-low-threshold(optional): string
  Default Value: 100 megabytes

  Low disk threshold to limit database updates.
• ds-cfg-enabled: boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-entries-compressed(optional): boolean
  Default Value: false

  Indicates whether the backend should attempt to compress entries before storing them in the database.
• ds-cfg-index-entry-limit(optional): integer(int32)
  Default Value: 4000

  Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained.
• ds-cfg-index-filter-analyzer-enabled(optional): boolean
  Default Value: false

  Indicates whether to gather statistical information about the search filters processed by the Directory Server while evaluating the usage of indexes.
• ds-cfg-index-subtrees(optional): boolean
  Default Value: true

  Indicates whether or not the backend should index subtrees to maintain subtree specific data retaining information on direct and indirect children entries of each parent entry.
• ds-cfg-is-private-backend(optional): boolean
  Default Value: false

  Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information.
• ds-cfg-java-class: string
  Default Value: org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the DB Local Backend Workflow Element implementation.
• ds-cfg-je-property(optional): array ds-cfg-je-property
  Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.
• ds-cfg-maintenance(optional): boolean
  Default Value: false

  Indicates whether the server DB Local Backend Workflow Element is in maintenance mode.
• ds-cfg-max-entries(optional): integer(int32)
  Default Value: 25

  The maximum number of search filter statistics to keep.
• ds-cfg-monitor-cold-attributes(optional): boolean
  Default Value: false

  Indicates whether cold attributes usage data collection and monitoring should be enabled.
• ds-cfg-preload-time-limit(optional): string
  Default Value: 0s

  Specifies the length of time that the backend is allowed to spend "pre-loading" data when it is initialized.
• ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
  The URLs that should be returned when the server is not able to fulfill the requests.
• ds-cfg-tombstone-creation-enabled(optional): boolean
  Default Value: true

  Indicates whether the backend should create a tombstone when an entry is deleted.
• ds-cfg-tombstone-lifetime(optional): string
  Default Value: 1w

  Specifies the lifetime of a tombstone after the entry has been deleted.
• ds-cfg-tombstone-purge-interval(optional): string
  Default Value: 5m

  Specifies the time interval after which tombstone purging is restarted.
• ds-cfg-writability-mode: string
  Default Value: enabled

  Allowed Values: [ "disabled", "enabled", "internal-only" ]

  Specifies the behavior that the backend should use when processing write operations.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-db-directory",
        "ds-cfg-writability-mode",
        "ds-cfg-base-dn"
    ],
    "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":"Specifies the fully-qualified name of the Java class that provides the DB Local Backend Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement",
            "type":"string"
        },
        "ds-cfg-db-log-file-max":{
            "description":"Specifies the maximum size for a database log file. ",
            "readOnly":false,
            "default":"100mb",
            "type":"string"
        },
        "ds-cfg-db-directory-permissions":{
            "description":"Specifies the permissions that should be applied to the directory containing the server database files. ",
            "readOnly":false,
            "default":"700",
            "type":"string"
        },
        "ds-cfg-index-filter-analyzer-enabled":{
            "description":"Indicates whether to gather statistical information about the search filters processed by the Directory Server while evaluating the usage of indexes. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "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-cache-size":{
            "description":"The amount of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "default":"0 MB",
            "type":"string"
        },
        "ds-cfg-preload-time-limit":{
            "description":"Specifies the length of time that the backend is allowed to spend \"pre-loading\" data when it is initialized. ",
            "readOnly":false,
            "default":"0s",
            "type":"string"
        },
        "ds-cfg-db-logging-file-handler-on":{
            "description":"Indicates whether the database should maintain a je.info file in the same directory as the database log directory. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "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-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-max-entries":{
            "description":"The maximum number of search filter statistics to keep. ",
            "readOnly":false,
            "default":25,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-is-private-backend":{
            "description":"Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-tombstone-purge-interval":{
            "description":"Specifies the time interval after which tombstone purging is restarted. ",
            "readOnly":false,
            "default":"5m",
            "type":"string"
        },
        "ds-cfg-db-run-cleaner":{
            "description":"Indicates whether the database cleaner threads should be enabled. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-txn-durability":{
            "description":"Specifies the durability of database transactions. ",
            "readOnly":false,
            "default":"write-to-filesystem",
            "type":"string",
            "enum":[
                "write-to-cache",
                "write-to-disk",
                "write-to-filesystem"
            ]
        },
        "ds-cfg-entries-compressed":{
            "description":"Indicates whether the backend should attempt to compress entries before storing them in the database. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-index-entry-limit":{
            "description":"Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "default":4000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-compact-encoding":{
            "description":"Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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 backend. ",
            "readOnly":false,
            "default":"db",
            "type":"string"
        },
        "ds-cfg-compact-attribute-values-using-tokens":{
            "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cache-mode":{
            "description":"Specifies the in-memory cache mode used for operations performed. ",
            "readOnly":false,
            "default":"default",
            "type":"string",
            "enum":[
                "default",
                "evict-bin",
                "evict-ln",
                "keep-hot",
                "make-cold",
                "unchanged"
            ]
        },
        "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-writability-mode":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"enabled",
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                "internal-only"
            ]
        },
        "ds-cfg-db-evictor-nodes-per-scan":{
            "description":"Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-tombstone-lifetime":{
            "description":"Specifies the lifetime of a tombstone after the entry has been deleted. ",
            "readOnly":false,
            "default":"1w",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN(s) for the data that the backend handles. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "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-evictor-lru-only":{
            "description":"Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first). ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-monitor-cold-attributes":{
            "description":"Indicates whether cold attributes usage data collection and monitoring should be enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-logging-level":{
            "description":"Specifies the log level that should be used by the database when it is writing information into the je.info file. ",
            "readOnly":false,
            "default":"CONFIG",
            "type":"string"
        },
        "ds-cfg-index-subtrees":{
            "description":"Indicates whether or not the backend should index subtrees to maintain subtree specific data retaining information on direct and indirect children entries of each parent entry. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-allow-undefined-attribute-search-filter":{
            "description":"Indicates whether an undefined attribute should be allowed in the search filter for processing. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-maintenance":{
            "description":"Indicates whether the server DB Local Backend Workflow Element is in maintenance mode. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-cache-percent":{
            "description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cold-attribute":{
            "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-tombstone-creation-enabled":{
            "description":"Indicates whether the backend should create a tombstone when an entry is deleted. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-base-dn

Type: array

Specifies the base DN(s) for the data that the backend handles.

Show Source

• Array of: string

{
    "description":"Specifies the base DN(s) for the data that the backend handles. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-cold-attribute

Type: array

Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage.

Show Source

• Array of: string

{
    "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-compact-attribute-values-using-tokens

Type: array

Indicates the list of attributes that the server should compact using token instead of values.

Show Source

• Array of: string

{
    "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "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 : ds-cfg-referrals-url

Type: array

The URLs that should be returned when the server is not able to fulfill the requests.

Show Source

• Array of: string

{
    "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
    "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

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