Update Replicat
patch
/services/{version}/replicats/{replicat}
Required Role: Operator
Update an existing replicat process. A user with the 'Operator' role may change the "status" property. Any other changes require the 'Administrator' role.
Request
Supported Media Types
- application/json
Path Parameters
-
replicat(required): string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$The name of the replicat. Replicat names are upper case, begin with an alphabetic character followed by up to seven alpha-numeric characters.
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Replicat
Type:
objectTitle:
Show Source
Oracle GoldenGate Replicat-
$schema:
Allowed Values:
[ "ogg:replicat" ] -
begin:
begin
Starting point for data processing
-
checkpoint:
checkpoint
Location for checkpoint data
-
config:
array config
Minimum Number of Items:
0Maximum Number of Items:32767 -
credentials:
credentials
Credentials for target database
-
critical:
boolean
Default Value:
falseIndicates the replicat is critical to the deployment -
description:
string
Minimum Length:
1Maximum Length:4095Description for the process -
encryptionProfile:
encryptionProfile
-
intent:
Default Value:
UnidirectionalAllowed Values:[ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]Intent for data capture workflow -
managedProcessSettings:
managedProcessSettings
Control how the ER process is managed by the Administration Server
-
mode:
mode
Mode of replication
-
registration:
Default Value:
noneAllowed Values:[ "none", "standard" ]Registration with the target database -
source:
source
Source of data to process
-
status:
Default Value:
stoppedAllowed Values:[ "starting", "running", "stopped", "killed", "abended" ]Oracle GoldenGate Process Status -
synchronized:
boolean
Indicates that the Replicat is stopped in a synchronized state
Nested Schema : begin
Starting point for data processing
Default Value:
nowMatch One
Show Source
-
Allowed Values:
[ "now" ] -
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$ -
object begin-x-oneOf[2]
Nested Schema : checkpoint
Location for checkpoint data
Match One
Show Source
-
Allowed Values:
[ "files" ]Use the local filesystem to store checkpoint data -
object checkpoint-x-oneOf[1]
Use the specified table to store checkpoint information
Nested Schema : config
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767-
Array of:
string
Minimum Length:
0Maximum Length:4095
Nested Schema : credentials
Credentials for target database
Default Value:
oracle.doceng.json.BetterJsonNull@7baf6acfMatch One
Show Source
Nested Schema : managedProcessSettings
Control how the ER process is managed by the Administration Server
Match One
Show Source
-
object managedProcessSettings-x-oneOf[0]
Custom settings
-
string
Minimum Length:
1Maximum Length:64Pattern:^[A-Za-z0-9][A-Za-z0-9_:-]*$Name of 'ogg:managedProcessSettings' configuration value
Nested Schema : mode
Mode of replication
Match One
Show Source
-
object mode-x-oneOf[0]
Creates a standard, non-integrated Replicat
-
object mode-x-oneOf[1]
(Oracle Only) Creates a standard, integrated Replicat
-
object mode-x-oneOf[2]
(Oracle Only) Coordinated Replicat
Nested Schema : source
Source of data to process
Match One
Show Source
-
Allowed Values:
[ "tables" ]Use tables (initial load) -
object source-x-oneOf[1]
-
object source-x-oneOf[2]
Nested Schema : begin-x-oneOf[2]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "type:position/atTrailRBA" ] -
offset:
integer
Minimum Value:
0Maximum Value:2147483647Default Value:0Offset in trail sequence file -
sequence(required):
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Trail file sequence number
Nested Schema : checkpoint-x-oneOf[1]
Type:
objectUse the specified table to store checkpoint information
Show Source
Nested Schema : credentials-x-oneOf[0]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:credentialsRef" ] -
alias(required):
string
Minimum Length:
1Maximum Length:30Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$ -
domain:
string
Minimum Length:
1Maximum Length:30Default Value:OracleGoldenGatePattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : managedProcessSettings-x-oneOf[0]
Type:
objectCustom settings
Show Source
-
$schema:
Allowed Values:
[ "ogg:managedProcessSettings" ] -
autoRestart:
object autoRestart
Control how the ER process is restarted by the Administration Server if it terminates
-
autoStart:
object autoStart
Description of how the ER process starts with Administration Server
Nested Schema : autoRestart
Type:
objectControl how the ER process is restarted by the Administration Server if it terminates
Default Value:
Show Source
{
"enabled":false,
"onSuccess":false,
"delay":"0",
"retries":"9",
"window":"60",
"disableOnFailure":true
}-
$schema:
Allowed Values:
[ "ogg:taskRestart" ] -
delay:
integer
Minimum Value:
0Maximum Value:3600Default Value:0The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process. -
disableOnFailure:
boolean
Default Value:
trueIf true, the task is disabled when it fails all execution attempts in an execution window. -
enabled(required):
boolean
Default Value:
falseIf set, the task can be restarted if it terminates. -
failures:
integer
Minimum Value:
0Maximum Value:3600The number of times the task failed in the current window. -
onSuccess:
boolean
Default Value:
falseIf false, the task is only restarted if it fails. -
retries:
integer
Minimum Value:
0Maximum Value:3600Default Value:9The maximum number of times the task should be restarted before aborting retry efforts. -
window:
integer
Minimum Value:
0Maximum Value:604800Default Value:60The window of time, in seconds, during which retries are counted.
Nested Schema : autoStart
Type:
objectDescription of how the ER process starts with Administration Server
Show Source
-
delay:
integer
Minimum Value:
0Maximum Value:3600Default Value:0Time to wait in seconds before starting process -
enabled(required):
boolean
Default Value:
falseIf set, the process is started when Administration Server starts
Nested Schema : mode-x-oneOf[0]
Type:
objectCreates a standard, non-integrated Replicat
Show Source
-
parallel:
parallel
-
type(required):
Allowed Values:
[ "nonintegrated" ]
Nested Schema : mode-x-oneOf[1]
Type:
object(Oracle Only) Creates a standard, integrated Replicat
Show Source
-
parallel:
boolean
Default Value:
falseApply multiple operations in parallel -
type(required):
Allowed Values:
[ "integrated" ]
Nested Schema : mode-x-oneOf[2]
Type:
object(Oracle Only) Coordinated Replicat
Show Source
-
maxThreads:
integer
Minimum Value:
1Maximum Value:500Default Value:25 -
threadNumber:
integer
Minimum Value:
1Maximum Value:500 -
type(required):
Allowed Values:
[ "coordinated" ]
Nested Schema : source-x-oneOf[1]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:file" ] -
filename(required):
string
Minimum Length:
1Maximum Length:4096The name of the file -
remote:
boolean
Default Value:
falseIndicates if file is local or remote
Nested Schema : source-x-oneOf[2]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:trailRef" ] -
name(required):
string
Minimum Length:
2Maximum Length:512Pattern:^[a-zA-Z0-9_#$/-]*$The name of the trail -
path:
string
Minimum Length:
1Maximum Length:4096The path where the trail data is stored
Example Request (application/json)
{
"status":"running"
}Response
Supported Media Types
- application/json
200 Response
The replicat process was successfully modified.
Root Schema : RESTful API Standard Response
Type:
objectTitle:
RESTful API Standard ResponseStandard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema:
Allowed Values:
[ "api:standardResponse" ] -
links(required):
array links
Minimum Number of Items:
0Maximum Number of Items:16Oracle GoldenGate links for the request -
messages(required):
array messages
Minimum Number of Items:
0Maximum Number of Items:65535Oracle GoldenGate messages issued during the request -
response:
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
65535Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
objectOracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:message" ] -
code(required):
string
Minimum Length:
9Maximum Length:9Pattern:^OGG[-][0-9]{5}$The Oracle GoldenGate message code -
issued(required):
string
Minimum Length:
20Maximum Length:32Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$The date and time that the message was issued -
severity(required):
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]The severity of the message -
title(required):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9012/services/v2/replicats/REPS",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/replicats/REPS",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
{
"$schema":"ogg:message",
"code":"OGG-00975",
"issued":"2024-04-03T22:35:29Z",
"severity":"INFO",
"title":"Replicat group REPS starting.",
"type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
},
{
"$schema":"ogg:message",
"code":"OGG-15445",
"issued":"2024-04-03T22:35:29Z",
"severity":"INFO",
"title":"Replicat group REPS started.",
"type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
}
]
}