REST API for Oracle Unified Directory Administration

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

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

• Array of: object Local DB Index SearchResultEntry

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

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

• cn: string
  CN (common name) of the entry
• ds-cfg-attribute: string
  Read Only: true

  Specifies the name of the attribute for which the index is to be maintained.
• ds-cfg-index-entry-limit: integer(int32)
  Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained.
• ds-cfg-index-extensible-matching-rule: array ds-cfg-index-extensible-matching-rule

  The extensible matching rule in an extensible index.

• ds-cfg-index-type(required): array ds-cfg-index-type

  Specifies the type(s) of indexing that should be performed for the associated attribute.

• ds-cfg-purging: boolean
  Default Value: false

  Indicates whether this index older values should be purged.
• ds-cfg-substring-length: integer(int32)
  Default Value: 6

  The length of substrings in a substring index.
• ds-cfg-tombstones-included: boolean
  Default Value: false

  Indicates whether this index is maintained for tombstone entries as well.
• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":"6",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

• Array of: string

Copy{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

• Array of: string

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

• 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

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