REST API for Oracle Unified Directory Administration

Modify a Union Partition by DN

patch

/rest/v1/admin/{dn}

Modify a Union Partition by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Union Partition that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

controls: array controls

LDAP controls to be sent to server for LDAP modify operation.
msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

The REST message type
operations(required): 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(required): string

The entry attribute to be modified.
opType(required): string

Allowed Values: [ "add", "delete", "replace", "increment" ]

The type of the Patch Operation.
values: 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"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Union Partition PatchSuccessResponse

Type: object

Show Source

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.

{
    "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/Union Partition SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Union Partition SearchResultEntry

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

Nested Schema : Union Partition SearchResultEntry

Type: object

Show Source

attributes(required): object Union Partition 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/Union Partition Properties"
        }
    }
}

Nested Schema : Union Partition Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-allowed-operations: array ds-cfg-allowed-operations

The operation types allowed in this partition.
ds-cfg-black-list-attributes: array ds-cfg-black-list-attributes

The list of attributes of DN syntax that must NOT be transformed.
ds-cfg-priority: integer(int32)

Default Value: 10

The priority of the partition.
ds-cfg-relative-base-dn: string

Default Value:

The relative part of the partition base DN.
ds-cfg-source-base-dn: string

Default Value:

The base DN for the source DIT.
ds-cfg-white-list-attributes: array ds-cfg-white-list-attributes

The list of attributes of DN syntax that must be transformed.
ds-cfg-workflow-element(required): string

The partition workflow element.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element"
    ],
    "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-white-list-attributes":{
            "description":"The list of attributes of DN syntax that must be transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-source-base-dn":{
            "description":"The base DN for the source DIT. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-workflow-element":{
            "description":"The partition workflow element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-relative-base-dn":{
            "description":"The relative part of the partition base DN. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"The priority of the partition. ",
            "readOnly":false,
            "default":"10",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-allowed-operations":{
            "description":"The operation types allowed in this partition. ",
            "readOnly":false,
            "default":[
                "search",
                "bind",
                "add",
                "delete",
                "modify",
                "modifyDN",
                "compare",
                "extended"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-black-list-attributes":{
            "description":"The list of attributes of DN syntax that must NOT be transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-allowed-operations

Type: array

The operation types allowed in this partition.

Default Value:

[
    "search",
    "bind",
    "add",
    "delete",
    "modify",
    "modifyDN",
    "compare",
    "extended"
]

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "extended",
    "modify",
    "modifydn",
    "search"
]

Show Source

Array of: string

{
    "description":"The operation types allowed in this partition. ",
    "readOnly":false,
    "default":[
        "search",
        "bind",
        "add",
        "delete",
        "modify",
        "modifyDN",
        "compare",
        "extended"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-black-list-attributes

Type: array

The list of attributes of DN syntax that must NOT be transformed.

Show Source

Array of: string

{
    "description":"The list of attributes of DN syntax that must NOT be transformed. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-white-list-attributes

Type: array

The list of attributes of DN syntax that must be transformed.

Show Source

Array of: string

{
    "description":"The list of attributes of DN syntax that must be transformed. ",
    "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

Root Schema : ErrorResponse

Type: object

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