Jump to

• Request
• Response

Update Replication Agreement

put

/oam/services/rest/_replication/{replId}

To be executed only on the Master Data Center. Updates the Specified parameters in the Replication Agreement based on the replicaType.

Request

Supported Media Types

• application/json

Path Parameters

• replId: string
  Replication Identifier for which Agreement should be updated.

Body ()

Root Schema : updateReplicationAgreementParams

Type: object

Show Source

• config(optional): object config
• enabled(optional): string
  true|false. To be specified when the replication agreement has to be enabled or disabled
• pollInterval(optional): string
  To be specified to alter the duration after which Clone DC polls and applies the changes from Master DC
• replicaType: string
  SUPPLIER|CONSUMER. Indicates if the Replication Agreement has to be updated in Master or Clone DC

{
    "type":"object",
    "required":[
        "replicaType"
    ],
    "properties":{
        "enabled":{
            "type":"string",
            "description":"true|false. To be specified when the replication agreement has to be enabled or disabled"
        },
        "replicaType":{
            "type":"string",
            "description":"SUPPLIER|CONSUMER. Indicates if the Replication Agreement has to be updated in Master or Clone DC"
        },
        "pollInterval":{
            "type":"string",
            "description":"To be specified to alter the duration after which Clone DC polls and applies the changes from Master DC"
        },
        "config":{
            "type":"object",
            "properties":{
                "entry":{
                    "type":"object",
                    "properties":{
                        "key":{
                            "type":"string",
                            "description":"authorization"
                        },
                        "value":{
                            "type":"string",
                            "description":"Authorization Header to be used for contacting Master or Clone DC depending on the replicaType"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : config

Type: object

Show Source

• entry(optional): object entry

{
    "type":"object",
    "properties":{
        "entry":{
            "type":"object",
            "properties":{
                "key":{
                    "type":"string",
                    "description":"authorization"
                },
                "value":{
                    "type":"string",
                    "description":"Authorization Header to be used for contacting Master or Clone DC depending on the replicaType"
                }
            }
        }
    }
}

Nested Schema : entry

Type: object

Show Source

• key(optional): string
  authorization
• value(optional): string
  Authorization Header to be used for contacting Master or Clone DC depending on the replicaType

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"authorization"
        },
        "value":{
            "type":"string",
            "description":"Authorization Header to be used for contacting Master or Clone DC depending on the replicaType"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response body shall indicate the status

Body ()

Root Schema : replAgreementResponse

Type: object

Show Source

• enabled(optional): string
  true|false
• identifier(optional): string
  Replication Agreement Identifier
• lastSequenceNumber(optional): string
  Sequence Number last applied in the DC
• ok(optional): string
  true|false
• pollInterval(optional): string
  Duration after which the Clone DC should poll and apply the changes from Master DC
• startingSequenceNumber(optional): string
  Sequence Number after which Replication will occur
• state(optional): string
  Current State of the Replication Agreement (ACTIVE|BOOTSTRAPPING|READY)

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"string",
            "description":"true|false"
        },
        "identifier":{
            "type":"string",
            "description":"Replication Agreement Identifier"
        },
        "lastSequenceNumber":{
            "type":"string",
            "description":"Sequence Number last applied in the DC"
        },
        "ok":{
            "type":"string",
            "description":"true|false"
        },
        "pollInterval":{
            "type":"string",
            "description":"Duration after which the Clone DC should poll and apply the changes from Master DC"
        },
        "startingSequenceNumber":{
            "type":"string",
            "description":"Sequence Number after which Replication will occur"
        },
        "state":{
            "type":"string",
            "description":"Current State of the Replication Agreement (ACTIVE|BOOTSTRAPPING|READY)"
        }
    }
}

500 Response

Error

Back to Top