Jump to

• Request
• Response

Modify a Hide Entries By Filter Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a Hide Entries By Filter Workflow Element by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be modified

Body ()

Hide Entries By Filter Workflow Element that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

• controls(optional): array controls
  LDAP controls to be sent to server for LDAP modify operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  The REST message type
• operations: 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

• [0]: 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

• [0]: 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: string
  The entry attribute to be modified.
• opType: string
  Allowed Values: [ "add", "delete", "replace", "increment" ]

  The type of the Patch Operation.
• values(optional): 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

• [0]: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Hide Entries By Filter Workflow Element PatchSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: 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/Hide Entries By Filter Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object Hide Entries By Filter Workflow Element SearchResultEntry

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

Nested Schema : Hide Entries By Filter Workflow Element SearchResultEntry

Type: object

Show Source

• attributes: object Hide Entries By Filter Workflow Element Properties
• dn: 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/Hide Entries By Filter Workflow Element Properties"
        }
    }
}

Nested Schema : Hide Entries By Filter Workflow Element Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-apply-for-admin: boolean
  Default Value: false

  Control whether the filtering is applicable to root users. If this parameter is set to false, and the bound user is a root user, the search results are returned as is, without being further filtered by the workflow element.
• ds-cfg-enabled: boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-excluded-ldap-url(optional): array ds-cfg-excluded-ldap-url
  Specifies a list of the LDAP URL used for the excluded filtering.
• ds-cfg-java-class: string
  Default Value: org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the Hide Entries By Filter Workflow Element implementation.
• ds-cfg-ldap-filter(optional): string
  Specifies the LDAP filter used for the filtering.
• ds-cfg-ldap-url(optional): array ds-cfg-ldap-url
  Specifies a list of the LDAP URL used for the filtering.
• ds-cfg-next-workflow-element: string
  Defines the next workflow element in the chain of workflow elements.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-apply-for-admin",
        "ds-cfg-next-workflow-element",
        "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 Hide Entries By Filter Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement",
            "type":"string"
        },
        "ds-cfg-ldap-filter":{
            "description":"Specifies the LDAP filter used for the filtering. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-excluded-ldap-url":{
            "description":"Specifies a list of the LDAP URL used for the excluded filtering. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-apply-for-admin":{
            "description":"Control whether the filtering is applicable to root users. If this parameter is set to false, and the bound user is a root user, the search results are returned as is, without being further filtered by the workflow element. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-next-workflow-element":{
            "description":"Defines the next workflow element in the chain of workflow elements. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ldap-url":{
            "description":"Specifies a list of the LDAP URL used for the filtering. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-excluded-ldap-url

Type: array

Specifies a list of the LDAP URL used for the excluded filtering.

Show Source

• [0]: string

{
    "description":"Specifies a list of the LDAP URL used for the excluded filtering. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-ldap-url

Type: array

Specifies a list of the LDAP URL used for the filtering.

Show Source

• [0]: string

{
    "description":"Specifies a list of the LDAP URL used for the filtering. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

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

400 Response

ERROR

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: 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."
        }
    }
}

Back to Top