Show Source

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

  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: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/Local DB VLV Index SearchResultEntry"
            }
        }
    }
}

Show Source

• Array of: object Local DB VLV Index SearchResultEntry

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

Show Source

• attributes(required): object Local DB VLV Index 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/Local DB VLV Index Properties"
        }
    }
}

Show Source

• cn: string
  CN (common name) of the entry
• ds-cfg-base-dn(required): string
  Specifies the base DN used in the search query that is being indexed.
• ds-cfg-filter(required): string
  Specifies the LDAP filter used in the query that is being indexed.
• ds-cfg-max-block-size: integer(int32)
  Read Only: true

  Default Value: 4000

  Specifies the number of entry IDs to store in a single sorted set before it must be split.
• ds-cfg-name: string
  Read Only: true

  Specifies a unique name for this VLV index.
• ds-cfg-scope(required): string
  Allowed Values: [ "base-object", "single-level", "subordinate-subtree", "whole-subtree" ]

  Specifies the LDAP scope of the query that is being indexed.
• ds-cfg-sort-order(required): string
  Specifies the names of the attributes that are used to sort the entries for the query being indexed.
• objectclass(required): array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-filter",
        "ds-cfg-sort-order",
        "ds-cfg-scope",
        "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-filter":{
            "description":"Specifies the LDAP filter used in the query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-max-block-size":{
            "description":"Specifies the number of entry IDs to store in a single sorted set before it must be split. ",
            "readOnly":true,
            "default":"4000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-sort-order":{
            "description":"Specifies the names of the attributes that are used to sort the entries for the query being indexed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-scope":{
            "description":"Specifies the LDAP scope of the query that is being indexed. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "base-object",
                "single-level",
                "subordinate-subtree",
                "whole-subtree"
            ]
        },
        "ds-cfg-name":{
            "description":"Specifies a unique name for this VLV index. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN used in the search query that is being indexed. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

Show Source

• Array of: string

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

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