REST API for Oracle Unified Directory Administration

Modify a Union Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a Union Workflow Element by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

Union Workflow Element 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 Workflow Element 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 Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Union Workflow Element SearchResultEntry

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

Nested Schema : Union Workflow Element SearchResultEntry

Type: object

Show Source

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

Nested Schema : Union Workflow Element Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-auto-tune-search-option: boolean

Default Value: false

A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true.
ds-cfg-base-dn: string

Read Only: true

The base DN of the virtual unified DIT.
ds-cfg-bind-option: string

Default Value: bind-first-success

Allowed Values: [ "bind-first-success", "bind-quick-fail" ]

Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions.
ds-cfg-cache-size: integer(int32)

Default Value: 10000

The maximum number of entries that can be stored in the cache used to filter out entry duplicates.
ds-cfg-enabled(required): boolean

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-java-class(required): string

Default Value: org.opends.server.workflowelement.union.UnionWorkflowElement

Specifies the fully-qualified name of the Java class that provides the Union Workflow Element implementation.
ds-cfg-search-first-match: boolean

Default Value: true

Indicates if a subtree search should stop the processing once an entry is found.
ds-cfg-suppress-entry-duplicates: boolean

Default Value: false

Indicate whether the Union Workflow Element should try to suppress the entry duplicates.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "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 Union Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.union.UnionWorkflowElement",
            "type":"string"
        },
        "ds-cfg-auto-tune-search-option":{
            "description":"A subtrees search with the filter e.g. !(uid=user.1) is likely to target a entry if search-first-match property is set to true however it should target several entries e.g. uid=user.2 and uid=user.3 as these could be valid results for this condition. To enable union workflow element to return several entries which are meeting the condition even if search-first-match is set to true, set this property to true. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-cache-size":{
            "description":"The maximum number of entries that can be stored in the cache used to filter out entry duplicates. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-search-first-match":{
            "description":"Indicates if a subtree search should stop the processing once an entry is found. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-suppress-entry-duplicates":{
            "description":"Indicate whether the Union Workflow Element should try to suppress the entry duplicates. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bind-option":{
            "description":"Indicates if a bind request should fall through the list of all configured partitions until it reaches first success or fail if multiple users have the same DN from different configured partitions. ",
            "readOnly":false,
            "default":"bind-first-success",
            "type":"string",
            "enum":[
                "bind-first-success",
                "bind-quick-fail"
            ]
        },
        "ds-cfg-base-dn":{
            "description":"The base DN of the virtual unified DIT. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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