REST API for Oracle Unified Directory Administration

Find Proportional Load Balancing Route by DN

get

/rest/v1/admin/{dn}

Returns an Proportional Load Balancing Route by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be fetched.

Query Parameters

attributes: array[string]

Collection Format: multi

List of attributes to be fetched for the entry.
controls: array[string]

Collection Format: multi

LDAP controls to be sent to server for search operation.
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 : Proportional Load Balancing Route GetSuccessResponse

Type: object

Show Source

msgType(required): string

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

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: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/Proportional Load Balancing Route SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Proportional Load Balancing Route SearchResultEntry

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

Nested Schema : Proportional Load Balancing Route SearchResultEntry

Type: object

Show Source

attributes(required): object Proportional Load Balancing Route 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/Proportional Load Balancing Route Properties"
        }
    }
}

Nested Schema : Proportional Load Balancing Route Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-add-weight(required): integer(int32)

Default Value: 1

The weight of the route for add operations.
ds-cfg-bind-weight(required): integer(int32)

Default Value: 1

The weight of the route for bind operations.
ds-cfg-compare-weight(required): integer(int32)

Default Value: 1

The weight of the route for compare operations.
ds-cfg-delete-weight(required): integer(int32)

Default Value: 1

The weight of the route for delete operations.
ds-cfg-extended-weight(required): integer(int32)

Default Value: 1

The weight of the route for extended operations.
ds-cfg-modify-weight(required): integer(int32)

Default Value: 1

The weight of the route for modify operations.
ds-cfg-modifydn-weight(required): integer(int32)

Default Value: 1

The weight of the route for modifyDN operations.
ds-cfg-search-weight(required): integer(int32)

Default Value: 1

The weight of the route for search operations.
ds-cfg-workflow-element: string

Read Only: true

The workflow element which contains the route.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-compare-weight",
        "ds-cfg-search-weight",
        "ds-cfg-delete-weight",
        "ds-cfg-add-weight",
        "ds-cfg-bind-weight",
        "ds-cfg-modify-weight",
        "ds-cfg-extended-weight",
        "ds-cfg-modifydn-weight"
    ],
    "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-compare-weight":{
            "description":"The weight of the route for compare operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-search-weight":{
            "description":"The weight of the route for search operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-workflow-element":{
            "description":"The workflow element which contains the route. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-delete-weight":{
            "description":"The weight of the route for delete operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-add-weight":{
            "description":"The weight of the route for add operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-bind-weight":{
            "description":"The weight of the route for bind operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-modify-weight":{
            "description":"The weight of the route for modify operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-extended-weight":{
            "description":"The weight of the route for extended operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-modifydn-weight":{
            "description":"The weight of the route for modifyDN operations. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        }
    }
}

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