Jump to

• Request
• Response

Modify a Replication Server by DN

patch

/rest/v1/admin/{dn}

Modify a Replication Server by DN

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Replication Server 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

• 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: 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

• Array of: 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 : Replication Server 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/Replication Server SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Replication Server SearchResultEntry

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

Nested Schema : Replication Server SearchResultEntry

Type: object

Show Source

• attributes: object Replication Server 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/Replication Server Properties"
        }
    }
}

Nested Schema : Replication Server Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-assured-timeout(optional): string
  Default Value: 1000ms

  The timeout value when waiting for assured mode acknowledgments.
• ds-cfg-degraded-status-threshold(optional): integer(int32)
  Default Value: 5000

  The number of pending changes as threshold value for putting a directory server in degraded status.
• ds-cfg-disk-full-replication-purge-delay(optional): string
  Default Value: 18000s

  The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold.
• ds-cfg-disk-full-threshold(optional): string
  Default Value: 20 megabytes

  Full disk threshold to stop the replication server
• ds-cfg-disk-low-threshold(optional): string
  Default Value: 100 megabytes

  Low disk threshold to start purging all persistent information
• ds-cfg-group-id(optional): integer(int32)
  Default Value: 1

  The group id for the replication server.
• ds-cfg-handshake-timeout(optional): string
  Default Value: 4000ms

  Specifies the handshake-timeout interval for the handshake between the replication servers.
• ds-cfg-heartbeat-interval(optional): string
  Default Value: 10000ms

  The maximum period of time that the connection to a peer RS will be considered active.
• ds-cfg-monitoring-period(optional): string
  Default Value: 3000ms

  The period between sending of monitoring messages.
• ds-cfg-queue-size(optional): integer(int32)
  Default Value: 10000

  Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain.
• ds-cfg-replication-db-directory(optional): string
  Read Only: true

  Default Value: changelogDb

  The path where the Replication Server stores all persistent information.
• ds-cfg-replication-port: integer(int32)
  The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers.
• ds-cfg-replication-purge-delay(optional): string
  Default Value: 360000s

  The time (in seconds) after which the Replication Server erases all persistent information.
• ds-cfg-replication-server(optional): array ds-cfg-replication-server
  Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.
• ds-cfg-replication-server-id(optional): integer(int32)
  Read Only: true

  Specifies a unique identifier for the Replication Server.
• ds-cfg-weight(optional): integer(int32)
  Default Value: 1

  The weight of the replication server.
• ds-cfg-window-size(optional): integer(int32)
  Default Value: 100

  Specifies the window size that the Replication Server uses when communicating with other Replication Servers.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-port"
    ],
    "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":"The maximum period of time that the connection to a peer RS will be considered active. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-degraded-status-threshold":{
            "description":"The number of pending changes as threshold value for putting a directory server in degraded status. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-group-id":{
            "description":"The group id for the replication server. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to stop the replication server ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-replication-db-directory":{
            "description":"The path where the Replication Server stores all persistent information. ",
            "readOnly":true,
            "default":"changelogDb",
            "type":"string"
        },
        "ds-cfg-replication-port":{
            "description":"The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-weight":{
            "description":"The weight of the replication server. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to start purging all persistent information ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-monitoring-period":{
            "description":"The period between sending of monitoring messages. ",
            "readOnly":false,
            "default":"3000ms",
            "type":"string"
        },
        "ds-cfg-disk-full-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold. ",
            "readOnly":false,
            "default":"18000s",
            "type":"string"
        },
        "ds-cfg-assured-timeout":{
            "description":"The timeout value when waiting for assured mode acknowledgments. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server-id":{
            "description":"Specifies a unique identifier for the Replication Server. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-queue-size":{
            "description":"Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain. ",
            "readOnly":false,
            "default":10000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries 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-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information. ",
            "readOnly":false,
            "default":"360000s",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Replication Server uses when communicating with other Replication Servers. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ds-cfg-replication-server

Type: array

Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time.

Show Source

• Array of: string

{
    "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries 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"
    }
}

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