REST API for Oracle Unified Directory Administration

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

  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.

Copy{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "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 System Entry Cache SearchResultEntry"
            }
        }
    }
}

• Array of: object File System Entry Cache SearchResultEntry

Copy{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/File System Entry Cache SearchResultEntry"
    }
}

• attributes: object File System Entry Cache Properties
• dn: string
  LDAP DN of the entry to be created

Copy{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/File System Entry Cache Properties"
        }
    }
}

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-cache-directory(optional): string
  Default Value: /tmp/OpenDS.FSCache

  Specifies the directory in which the JE environment should store the cache.
• ds-cfg-cache-level: integer(int32)
  Specifies the cache level in the cache order if more than one instance of the cache is configured.
• ds-cfg-cache-type(optional): string
  Default Value: fifo

  Allowed Values: [ "fifo", "lru" ]

  Specifies the policy which should be used for purging entries from the cache.
• ds-cfg-compact-encoding(optional): boolean
  Default Value: true

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

  Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory.
• ds-cfg-db-cache-size(optional): string
  Default Value: 0b

  Specifies the maximum JVM memory usage in bytes for the internal JE cache.
• ds-cfg-enabled: boolean
  Indicates whether the Entry Cache is enabled.
• ds-cfg-exclude-filter(optional): array ds-cfg-exclude-filter

  The set of filters that define the entries that should be excluded from the cache.

• ds-cfg-include-filter(optional): array ds-cfg-include-filter

  The set of filters that define the entries that should be included in the cache.

• ds-cfg-java-class: string
  Default Value: org.opends.server.extensions.FileSystemEntryCache

  Specifies the fully-qualified name of the Java class that provides the File System Entry Cache implementation.
• ds-cfg-je-property(optional): array ds-cfg-je-property

  Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache.

• ds-cfg-lock-timeout(optional): string
  Default Value: 2000.0ms

  The length of time to wait while attempting to acquire a read or write lock.
• ds-cfg-max-entries(optional): integer(int32)
  Default Value: 2147483647

  The maximum number of entries allowed in the cache.
• ds-cfg-max-memory-size(optional): string
  Default Value: 0b

  The maximum size of the entry cache in bytes.
• ds-cfg-persistent-cache(optional): boolean
  Default Value: false

  Specifies whether the cache should persist across restarts.
• objectclass: array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-cache-level",
        "ds-cfg-enabled"
    ],
    "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 File System Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FileSystemEntryCache",
            "type":"string"
        },
        "ds-cfg-compact-encoding":{
            "description":"Indicates whether the cache should use a compact form when encoding cache entries by compressing the attribute descriptions and object class sets. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-cache-size":{
            "description":"Specifies the maximum JVM memory usage in bytes for the internal JE cache. ",
            "readOnly":false,
            "default":"0b",
            "type":"string"
        },
        "ds-cfg-je-property":{
            "description":"Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache. ",
            "readOnly":false,
            "default":[
                "je.env.isLocking=false"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-include-filter":{
            "description":"The set of filters that define the entries that should be included in the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-persistent-cache":{
            "description":"Specifies whether the cache should persist across restarts. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-cache-level":{
            "description":"Specifies the cache level in the cache order if more than one instance of the cache is configured. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Entry Cache is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-max-memory-size":{
            "description":"The maximum size of the entry cache in bytes. ",
            "readOnly":false,
            "default":"0b",
            "type":"string"
        },
        "ds-cfg-exclude-filter":{
            "description":"The set of filters that define the entries that should be excluded from the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-entries":{
            "description":"The maximum number of entries allowed in the cache. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cache-type":{
            "description":"Specifies the policy which should be used for purging entries from the cache. ",
            "readOnly":false,
            "default":"fifo",
            "type":"string",
            "enum":[
                "fifo",
                "lru"
            ]
        },
        "ds-cfg-db-cache-percent":{
            "description":"Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cache-directory":{
            "description":"Specifies the directory in which the JE environment should store the cache. ",
            "readOnly":false,
            "default":"/tmp/OpenDS.FSCache",
            "type":"string"
        },
        "ds-cfg-lock-timeout":{
            "description":"The length of time to wait while attempting to acquire a read or write lock. ",
            "readOnly":false,
            "default":"2000.0ms",
            "type":"string"
        }
    }
}

• Array of: string

Copy{
    "description":"The set of filters that define the entries that should be excluded from the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"The set of filters that define the entries that should be included in the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache. ",
    "readOnly":false,
    "default":[
        "je.env.isLocking=false"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

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

• 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

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