REST API for Oracle Unified Directory Administration

Find Tokenize Attribute Transformation by DN

get

/rest/v1/admin/{dn}

Returns an Tokenize Attribute Transformation by DN

Request

Supported Media Types

application/json

Path Parameters

dn: string

LDAP DN of the entry to be fetched.

Query Parameters

attributes: array

Collection Format: multi

List of attributes to be fetched for the entry.

[0]: string

{
    "name":"attributes",
    "in":"query",
    "description":"List of attributes to be fetched for the entry.",
    "type":"array",
    "collectionFormat":"multi",
    "items":{
        "type":"string"
    }
}

controls: array

Collection Format: multi

LDAP controls to be sent to server for search operation.

[0]: string

{
    "name":"controls",
    "in":"query",
    "description":"LDAP controls to be sent to server for search operation.",
    "type":"array",
    "collectionFormat":"multi",
    "items":{
        "type":"string"
    }
}

filter: string

Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
scope: string

Scope for the LDAP search operation.

Allowed Values: [ "base", "sub", "one" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Tokenize Attribute Transformation GetSuccessResponse

Type: object

Show Source

msgType: string

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

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: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/Tokenize Attribute Transformation SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Tokenize Attribute Transformation SearchResultEntry

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

Nested Schema : Tokenize Attribute Transformation SearchResultEntry

Type: object

Show Source

attributes: object Tokenize Attribute Transformation 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/Tokenize Attribute Transformation Properties"
        }
    }
}

Nested Schema : Tokenize Attribute Transformation Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-entry-match-filter(optional): string

Specifies the filter that the entry must match for this transformation to apply.
ds-cfg-entry-parent-suffix(optional): array ds-cfg-entry-parent-suffix

Specifies an antecedent of the operation DN for this transformation to apply.
ds-cfg-excluded-operation(optional): array ds-cfg-excluded-operation

Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.
ds-cfg-java-class: string

Default Value: org.opends.server.core.transformations.attributetransformations.TokenizeAttribute

Specifies the fully-qualified name of the Java class that provides the Tokenize Attribute Transformation implementation.
ds-cfg-multivalued-attribute: array ds-cfg-multivalued-attribute

Attribute whose value is stored as a single value will be tokenized with the delimiter.
ds-cfg-transformation-value-delimiter(optional): string

Default Value: ,

Specifies the delimiter to tokenize the attribute value to multiple values.By default the value will be ","
objectclass: array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-multivalued-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-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the Tokenize Attribute Transformation implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.transformations.attributetransformations.TokenizeAttribute",
            "type":"string"
        },
        "ds-cfg-entry-match-filter":{
            "description":"Specifies the filter that the entry must match for this transformation to apply. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-transformation-value-delimiter":{
            "description":"Specifies the delimiter to tokenize the attribute value to multiple values.By default the value will be \",\" ",
            "readOnly":false,
            "default":",",
            "type":"string"
        },
        "ds-cfg-multivalued-attribute":{
            "description":"Attribute whose value is stored as a single value will be tokenized with the delimiter. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-excluded-operation":{
            "description":"Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-entry-parent-suffix":{
            "description":"Specifies an antecedent of the operation DN for this transformation to apply. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-entry-parent-suffix

Type: array

Specifies an antecedent of the operation DN for this transformation to apply.

Show Source

Array of: string

{
    "description":"Specifies an antecedent of the operation DN for this transformation to apply. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-excluded-operation

Type: array

Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.

Allowed Values:

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

Show Source

Array of: string

{
    "description":"Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-multivalued-attribute

Type: array

Attribute whose value is stored as a single value will be tokenized with the delimiter.

Show Source

Array of: string

{
    "description":"Attribute whose value is stored as a single value will be tokenized with the delimiter. ",
    "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"
    }
}

406 Response

Not Acceptable

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