REST API for Oracle Unified Directory Administration

Find Global Index Catalog Replication Domain by DN

get

/rest/v1/admin/{dn}

Returns an Global Index Catalog Replication Domain 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 : Global Index Catalog Replication Domain 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/Global Index Catalog Replication Domain SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Global Index Catalog Replication Domain SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Global Index Catalog Replication Domain SearchResultEntry"
    }
}

Nested Schema : Global Index Catalog Replication Domain SearchResultEntry

Type: object

Show Source

attributes(required): object Global Index Catalog Replication Domain 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/Global Index Catalog Replication Domain Properties"
        }
    }
}

Nested Schema : Global Index Catalog Replication Domain Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-changetime-heartbeat-interval: string

Default Value: 1000ms

Specifies the heart-beat interval that the instance will use when sending its local change time to the Replication Server.
ds-cfg-group-id: integer(int32)

Default Value: 1

The group id associated with this replicated domain.
ds-cfg-handshake-timeout: string

Default Value: 4000ms

Specifies the handshake-timeout interval for the handshake between the replication servers.
ds-cfg-heartbeat-interval: string

Default Value: 1000ms

Specifies the heart-beat interval that the instance will use when communicating with Replication Servers.
ds-cfg-replication-server(required): array ds-cfg-replication-server

Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index should try to connect at startup time.
ds-cfg-server-id: integer(int32)

Read Only: true

Specifies a unique identifier for the global index within the Global Index Catalog Replication Domain.
ds-cfg-window-size: integer(int32)

Default Value: 100

Specifies the window size that the instance will use when communicating with Replication Servers.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-server"
    ],
    "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-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the instance will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-group-id":{
            "description":"The group id associated with this replicated domain. ",
            "readOnly":false,
            "default":"1",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-changetime-heartbeat-interval":{
            "description":"Specifies the heart-beat interval that the instance will use when sending its local change time to the Replication Server. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index should try to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-handshake-timeout":{
            "description":"Specifies the handshake-timeout interval for the handshake between the replication servers. ",
            "readOnly":false,
            "default":"4000ms",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the instance will use when communicating with Replication Servers. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-server-id":{
            "description":"Specifies a unique identifier for the global index within the Global Index Catalog Replication Domain. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index should try to connect at startup time.

Show Source

Array of: string

{
    "description":"Specifies the addresses of the Replication Servers within the Global Index Catalog Replication Domain to which the global index should try to connect at startup time. ",
    "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: 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."
        }
    }
}