REST API for Oracle Unified Directory Administration

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

Copy{
    "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/Objectclass Mapping SearchResultEntry"
            }
        }
    }
}

• Array of: object Objectclass Mapping SearchResultEntry

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

• attributes(required): object Objectclass Mapping 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/Objectclass Mapping Properties"
        }
    }
}

• cn: string
  CN (common name) of the entry
• ds-cfg-objectclass-name(required): string
  The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object.
• ds-cfg-rdn-attribute(required): string
  This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs.
• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-objectclass-name",
        "ds-cfg-rdn-attribute"
    ],
    "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-objectclass-name":{
            "description":"The LDAP Objectclass name for entries generated by this Objectclass Mapping. If the objectclass is not defined in the server schema, then it is added automatically to the server schema during server startup. If it already exists then it is not added. The attributes that MUST/MAY exist for defining an entry of a particular objectclass as per the schema are not relevant as the user has to explicitly define the attributes required by the entries through the Attribute Mappings managed object. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-rdn-attribute":{
            "description":"This property defines the sequence of RDN attributes required to construct the DN of the entries belonging to this Objectclass Mapping. The sequence of attributes is specified as a comma separated list. Example Values: 1) cn 2) cn,o 3) uid+cn+sn,o The DN of the entries is constructed by populating the values of the attributes in the RDN attribute and concatenating it to the suffix DN for the RDBMS Workflow Element to which the Objectclass Mapping belongs. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

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