Update Replicat
patch
/services/{version}/replicats/{replicat}
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: string
Minimum Length:
1
Maximum Length:8
Pattern:^[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: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Replicat
Type:
object
Title:
Show Source
Oracle GoldenGate Replicat
-
$schema(optional):
Allowed Values:
[ "ogg:replicat" ]
-
begin(optional):
begin
Starting point for data processing
-
checkpoint(optional):
checkpoint
Location for checkpoint data
-
config(optional):
array config
Minimum Number of Items:
0
Maximum Number of Items:32767
-
credentials(optional):
credentials
Credentials for target database
-
critical(optional):
boolean
Default Value:
false
Indicates the replicat is critical to the deployment -
description(optional):
string
Minimum Length:
1
Maximum Length:4095
Description for the process -
encryptionProfile(optional):
encryptionProfile
-
intent(optional):
Default Value:
Unidirectional
Allowed Values:[ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]
Intent for data capture workflow -
managedProcessSettings(optional):
managedProcessSettings
Control how the ER process is managed by the Administration Server
-
mode(optional):
mode
Mode of replication
-
registration(optional):
Default Value:
none
Allowed Values:[ "none", "standard" ]
Registration with the target database -
source(optional):
source
Source of data to process
-
status(optional):
Default Value:
stopped
Allowed Values:[ "starting", "running", "stopped", "killed", "abended" ]
Oracle GoldenGate Process Status -
synchronized(optional):
boolean
Indicates that the Replicat is stopped in a synchronized state
Nested Schema : begin
Starting point for data processing
Default Value:
now
Match One
Show Source
-
Allowed Values:
[ "now" ]
-
string
Minimum Length:
20
Maximum Length:32
Pattern:^[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:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
32767
-
Array of:
string
Minimum Length:
0
Maximum Length:4095
Nested Schema : credentials
Credentials for target database
Default Value:
oracle.doceng.json.BetterJsonNull@1055d261
Match 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:
1
Maximum Length:64
Pattern:^[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(optional):
Allowed Values:
[ "type:position/atTrailRBA" ]
-
offset(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
Default Value:0
Offset in trail sequence file -
sequence:
integer
Minimum Value:
0
Maximum Value:999999999
Default Value:0
Trail file sequence number
Nested Schema : checkpoint-x-oneOf[1]
Type:
object
Use the specified table to store checkpoint information
Show Source
Nested Schema : credentials-x-oneOf[0]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : managedProcessSettings-x-oneOf[0]
Type:
object
Custom settings
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:managedProcessSettings" ]
-
autoRestart(optional):
object autoRestart
Control how the ER process is restarted by the Administration Server if it terminates
-
autoStart(optional):
object autoStart
Description of how the ER process starts with Administration Server
Nested Schema : autoRestart
Type:
object
Control 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(optional):
Allowed Values:
[ "ogg:taskRestart" ]
-
delay(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:0
The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process. -
disableOnFailure(optional):
boolean
Default Value:
true
If true, the task is disabled when it fails all execution attempts in an execution window. -
enabled:
boolean
Default Value:
false
If set, the task can be restarted if it terminates. -
failures(optional):
integer
Minimum Value:
0
Maximum Value:3600
The number of times the task failed in the current window. -
onSuccess(optional):
boolean
Default Value:
false
If false, the task is only restarted if it fails. -
retries(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:9
The maximum number of times the task should be restarted before aborting retry efforts. -
window(optional):
integer
Minimum Value:
0
Maximum Value:604800
Default Value:60
The window of time, in seconds, during which retries are counted.
Nested Schema : autoStart
Type:
object
Description of how the ER process starts with Administration Server
Show Source
-
delay(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:0
Time to wait in seconds before starting process -
enabled:
boolean
Default Value:
false
If set, the process is started when Administration Server starts
Nested Schema : mode-x-oneOf[0]
Type:
object
Creates a standard, non-integrated Replicat
Show Source
-
parallel(optional):
boolean
Default Value:
false
Apply multiple operations in parallel -
type:
Allowed Values:
[ "nonintegrated" ]
Nested Schema : mode-x-oneOf[1]
Type:
object
(Oracle Only) Creates a standard, integrated Replicat
Show Source
-
parallel(optional):
boolean
Default Value:
false
Apply multiple operations in parallel -
type:
Allowed Values:
[ "integrated" ]
Nested Schema : mode-x-oneOf[2]
Type:
object
(Oracle Only) Coordinated Replicat
Show Source
-
maxThreads(optional):
integer
Minimum Value:
1
Maximum Value:500
Default Value:25
-
threadNumber(optional):
integer
Minimum Value:
1
Maximum Value:500
-
type:
Allowed Values:
[ "coordinated" ]
Nested Schema : source-x-oneOf[1]
Type:
Show Source
object
-
name:
string
Minimum Length:
2
Maximum Length:2
Pattern:^[A-Za-z][A-Za-z0-9]$
The name of the trail -
path(optional):
string
Minimum Length:
1
Maximum Length:4096
The path where the trail data is stored
Nested Schema : source-x-oneOf[2]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:file" ]
-
filename:
string
Minimum Length:
1
Maximum Length:4096
The name of the file -
remote(optional):
boolean
Default Value:
false
Indicates if file is local or remote
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:
object
Title:
RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema(optional):
Allowed Values:
[ "api:standardResponse" ]
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
response(optional):
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
object
Oracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:message" ]
-
code:
string
Minimum Length:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued:
string
Minimum Length:
20
Maximum Length:32
Pattern:^[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:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]
The severity of the message -
title:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[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:11001/services/v2/replicats/REP2",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/replicats/REP2",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
{
"$schema":"ogg:message",
"code":"OGG-00975",
"issued":"2021-07-13T16:38:51Z",
"severity":"INFO",
"title":"Replicat group REP2 starting.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-00975"
},
{
"$schema":"ogg:message",
"code":"OGG-15445",
"issued":"2021-07-13T16:38:51Z",
"severity":"INFO",
"title":"Replicat group REP2 started.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-15445"
}
]
}