Execute Command
post
/services/{version}/commands/execute
Required Role: User
Execute a command. Reporting commands are accessible for users with the 'User' role. Other commands require the 'Operator' role.
Request
Supported Media Types
- application/json
Path Parameters
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Task Manager Command
Title:
Oracle GoldenGate Task Manager CommandMatch One
Show Source
-
object Oracle GoldenGate Task Manager Command-x-oneOf[0]
Start an Extract or Replicat
-
object Oracle GoldenGate Task Manager Command-x-oneOf[1]
Stop an Extract or Replicat
-
object Oracle GoldenGate Task Manager Command-x-oneOf[2]
Kill an Extract or Replicat
-
object Oracle GoldenGate Task Manager Command-x-oneOf[3]
Execute an Extract or Replicat
-
object Oracle GoldenGate Task Manager Command-x-oneOf[4]
Collect diagnostic data for an integrated Extract or Replicat for the Oracle database
-
object Oracle GoldenGate Task Manager Command-x-oneOf[5]
Synchronize a Replicat
-
object Oracle GoldenGate Task Manager Command-x-oneOf[6]
Report on Processes
-
object Oracle GoldenGate Task Manager Command-x-oneOf[7]
Report on Process Lag
-
object Oracle GoldenGate Task Manager Command-x-oneOf[8]
Report Operating System and database version information
-
object Oracle GoldenGate Task Manager Command-x-oneOf[9]
Lists the schemas in the database with names that match the input specification
-
object Oracle GoldenGate Task Manager Command-x-oneOf[10]
Lists the tables in the database with names that match the input specification
-
object Oracle GoldenGate Task Manager Command-x-oneOf[11]
Lists the checkpoint tables in the database with names that match the input specification
-
object Oracle GoldenGate Task Manager Command-x-oneOf[12]
Lists the containers in the database with names that match the input specification
-
object Oracle GoldenGate Task Manager Command-x-oneOf[13]
Purge checkpoint history for ER processes
-
object Oracle GoldenGate Task Manager Command-x-oneOf[14]
-
object Oracle GoldenGate Task Manager Command-x-oneOf[15]
Purge trail files no longer needed
-
object Oracle GoldenGate Task Manager Command-x-oneOf[16]
Update Heartbeat Table (PostgreSQL only)
-
object Oracle GoldenGate Task Manager Command-x-oneOf[17]
Archive/restore trail sequences
-
object Oracle GoldenGate Task Manager Command-x-oneOf[18]
Purge Extract or Replicat tasks
-
object Oracle GoldenGate Task Manager Command-x-oneOf[19]
Purge files no longer needed
-
object Oracle GoldenGate Task Manager Command-x-oneOf[20]
Purge change data - currently only implemented for SQL Server
-
object Oracle GoldenGate Task Manager Command-x-oneOf[21]
Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[0]
Type:
objectStart an Extract or Replicat
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
after:
after
Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.
-
at:
at
Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.
-
filterDuplicates:
boolean
Default Value:
trueCauses Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true. -
name:
Allowed Values:
[ "start" ] -
processName:
string
Minimum Length:
1Maximum Length:8Pattern:^[*A-Z_$][*A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ] -
resetBoundedRecovery:
boolean
Default Value:
falseReset Bounded Recovery and use normal recovery instead -
skipTransaction:
boolean
Default Value:
falseCauses Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded. -
threads:
array threads
Minimum Number of Items:
1Maximum Number of Items:500Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.
Match All
Start an Extract or Replicat
Start an Extract or Replicat
Start an Extract or Replicat
Start an Extract or Replicat
Start an Extract or Replicat
Start an Extract or Replicat
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[1]
Type:
objectStop an Extract or Replicat
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
force:
boolean
Default Value:
false -
name(required):
Allowed Values:
[ "stop" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[*A-Z_$][*A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[2]
Type:
objectKill an Extract or Replicat
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
name(required):
Allowed Values:
[ "kill" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[*A-Z_$][*A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[3]
Type:
objectExecute an Extract or Replicat
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
name(required):
Allowed Values:
[ "execute" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[4]
Type:
objectCollect diagnostic data for an integrated Extract or Replicat for the Oracle database
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
collectionDuration:
integer
Minimum Value:
1Maximum Value:60Default Value:10Data collection duration in minutes -
collectionFrequency:
integer
Minimum Value:
5Maximum Value:60Default Value:10Data collection frequency in seconds -
name(required):
Allowed Values:
[ "diagnostics" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[5]
Type:
objectSynchronize a Replicat
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
name(required):
Allowed Values:
[ "synchronize" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[*A-Z_$][*A-Z0-9_$]*$ -
processType:
Allowed Values:
[ "replicat" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[6]
Type:
objectReport on Processes
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
name(required):
Allowed Values:
[ "report" ] -
reportType(required):
Allowed Values:
[ "up", "down" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[7]
Type:
objectReport on Process Lag
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
name(required):
Allowed Values:
[ "report" ] -
reportType(required):
Allowed Values:
[ "lag" ] -
thresholds(required):
array thresholds
Minimum Number of Items:
1Maximum Number of Items:2
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[8]
Type:
objectReport Operating System and database version information
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials:
credentials
Credentials for database
-
name(required):
Allowed Values:
[ "report" ] -
reportType(required):
Allowed Values:
[ "versions" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[9]
Type:
objectLists the schemas in the database with names that match the input specification
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
name(required):
Allowed Values:
[ "report" ] -
qualified:
boolean
Default Value:
trueIf true, returned schema names are fully qualified -
reportType(required):
Allowed Values:
[ "schemas" ] -
specification(required):
specification
The name of a schema which can include wildcard characters
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[10]
Type:
objectLists the tables in the database with names that match the input specification
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
name(required):
Allowed Values:
[ "report" ] -
qualified:
boolean
Default Value:
trueIf true, returned table names are fully qualified -
reportType(required):
Allowed Values:
[ "tables" ] -
specification(required):
specification
The name of a table or a group of tables which can include wildcard characters
-
tableType:
Default Value:
anyAllowed Values:[ "any", "auto_capture", "checkpoint" ]The type of table to list
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[11]
Type:
objectLists the checkpoint tables in the database with names that match the input specification
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
name(required):
Allowed Values:
[ "report" ] -
reportType(required):
Allowed Values:
[ "checkpointTables" ] -
specification(required):
specification
The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[12]
Type:
objectLists the containers in the database with names that match the input specification
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
name(required):
Allowed Values:
[ "report" ] -
reportType(required):
Allowed Values:
[ "containers" ] -
specification(required):
string
Minimum Length:
1Maximum Length:130Pattern:^([^."]{1,128}|["].{1,128}["])$The name of a container or a group of containers which can include wildcard characters
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[13]
Type:
objectPurge checkpoint history for ER processes
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
keep(required):
array keep
Minimum Number of Items:
1Maximum Number of Items:1 -
name(required):
Allowed Values:
[ "purge" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[*A-Z_$][*A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ] -
purgeType(required):
Allowed Values:
[ "checkpoints" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[14]
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
keep(required):
array keep
Minimum Number of Items:
1Maximum Number of Items:2 -
name(required):
Allowed Values:
[ "purge" ] -
purgeType(required):
Allowed Values:
[ "ddlHistory", "ddlHistoryAlt", "markerHistory" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[15]
Type:
objectPurge trail files no longer needed
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
keep(required):
array keep
Minimum Number of Items:
1Maximum Number of Items:1 -
name(required):
Allowed Values:
[ "purge" ] -
purgeType(required):
Allowed Values:
[ "trails" ] -
trails(required):
array trails
Minimum Number of Items:
1Maximum Number of Items:1024Trails to purge -
useCheckpoints:
boolean
Default Value:
true
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[16]
Type:
objectUpdate Heartbeat Table (PostgreSQL only)
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[17]
Type:
objectArchive/restore trail sequences
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
archiveTarget(required):
archiveTarget
-
name(required):
Allowed Values:
[ "archive", "restore" ] -
sequences:
object sequences
Optional range of trail sequences to process. If not present, all sequences in a trail are processed.
-
trails(required):
array trails
Minimum Number of Items:
1Maximum Number of Items:1024Trails to process
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[18]
Type:
objectPurge Extract or Replicat tasks
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
keep(required):
array keep
Minimum Number of Items:
1Maximum Number of Items:1 -
name(required):
Allowed Values:
[ "purge" ] -
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[*A-Z_$][*A-Z0-9_$]*$ -
processType:
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ] -
purgeType(required):
Allowed Values:
[ "tasks" ] -
useStatus:
boolean
Default Value:
false
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[19]
Type:
objectPurge files no longer needed
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
dumpFiles:
boolean
Default Value:
falsePurge dump files (*.dmp) which are generated when an application abnormally terminates -
keep(required):
array keep
Minimum Number of Items:
1Maximum Number of Items:1 -
name(required):
Allowed Values:
[ "purge" ] -
purgeType(required):
Allowed Values:
[ "files" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[20]
Type:
objectPurge change data - currently only implemented for SQL Server
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
keep(required):
array keep
Minimum Number of Items:
1Maximum Number of Items:1 -
name(required):
Allowed Values:
[ "purge" ] -
purgeType(required):
Allowed Values:
[ "changeData" ]
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[21]
Type:
objectUpdates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.
Show Source
-
$schema:
Allowed Values:
[ "ogg:command" ] -
credentials(required):
object credentials
Credentials for database
-
name(required):
Allowed Values:
[ "flushSequence" ] -
sequence(required):
sequence
The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.
-
trace:
boolean
Default Value:
falseWhether to call the sql procedure to update the sequence with tracing mode on
Nested Schema : after
Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.
Match Any
Show Source
-
after-x-anyOf[0]
-
after-x-anyOf[1]
-
string
Minimum Length:
3Maximum Length:41Pattern:^([0-9]{1,20}[.][0-9]{1,20})$Log Record Identifer(LRI) pattern for DB2LUW Database.Example:65423.12345 -
string
Minimum Length:
1Maximum Length:25Pattern:^([0][Xx][a-fA-F0-9]{1,20})|([0-9]{1,25})$Log Sequence Number (LSN) pattern for DB2ZOS Database.Example:0xa123bcde -
after-x-anyOf[4]
-
string
Minimum Length:
15Maximum Length:56Pattern:^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$Commit Sequence Number pattern for MSSQL Database.Example:0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445 -
string
Minimum Length:
3Maximum Length:17Pattern:^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$Commit Sequence Number pattern for PostgreSQL Database.Example:9acd12/231bcf -
string
Minimum Length:
7Maximum Length:33Pattern:^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$Commit Sequence Number pattern for Sybase Database.Example:00000.0026487383.0000533650.00034 -
null
Commit Sequence Number for Teradata (Not Supported)
-
string
Minimum Length:
1Maximum Length:100Pattern:^([A-Za-z0-9_]{1,100})$Commit Sequence Number pattern for Generic Database.Example:9acd12231bcf
Nested Schema : at
Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.
Match Any
Show Source
-
at-x-anyOf[0]
-
at-x-anyOf[1]
-
string
Minimum Length:
3Maximum Length:41Pattern:^([0-9]{1,20}[.][0-9]{1,20})$Log Record Identifer(LRI) pattern for DB2LUW Database.Example:65423.12345 -
string
Minimum Length:
1Maximum Length:25Pattern:^([0][Xx][a-fA-F0-9]{1,20})|([0-9]{1,25})$Log Sequence Number (LSN) pattern for DB2ZOS Database.Example:0xa123bcde -
at-x-anyOf[4]
-
string
Minimum Length:
15Maximum Length:56Pattern:^([0][Xx]([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4})-([0-9a-fA-F]{1,8})-([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,8}):([0-9a-fA-F]{1,4}))$Commit Sequence Number pattern for MSSQL Database.Example:0X00000d7e:0000036b:01bd, 0000003454:0000000875:00445, 0Xd7e:36b:1bd, 3454:875:445,3454000000087500445 -
string
Minimum Length:
3Maximum Length:17Pattern:^(([0-9a-fA-F]{1,8})/([0-9a-fA-F]{1,8}))$Commit Sequence Number pattern for PostgreSQL Database.Example:9acd12/231bcf -
string
Minimum Length:
7Maximum Length:33Pattern:^([0-9]{1-5}[.][0-9]{1-10}[.][0-9]{1-10}[.][0-9]{1-5})$Commit Sequence Number pattern for Sybase Database.Example:00000.0026487383.0000533650.00034 -
null
Commit Sequence Number for Teradata (Not Supported)
-
string
Minimum Length:
1Maximum Length:100Pattern:^([A-Za-z0-9_]{1,100})$Commit Sequence Number pattern for Generic Database.Example:9acd12231bcf
Nested Schema : threads
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
500Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.
Show Source
-
Array of:
integer
Minimum Value:
1Maximum Value:500
Nested Schema : after-x-anyOf[1]
Match One
Show Source
-
string
Minimum Length:
3Maximum Length:37Pattern:^([0-9]+[:][0-9]+)$Commit Sequence Number pattern(Legacy) for MySQL Database.Example:6488359:564781 -
string
Minimum Length:
77Maximum Length:77Pattern:^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$CSN pattern(GTID format) for MySQL Database.Example:00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654
Nested Schema : after-x-anyOf[4]
Match One
Show Source
-
integer
Minimum Value:
1Maximum Value:18446744073709552000Commit Sequence Number pattern (Legacy) for DB2400 Database.Example:78654321 -
string
Minimum Length:
32Maximum Length:32Pattern:^([a-fA-F0-9]{32})$Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.Example:F0B4993FD22315E5F0B4993FD22315E5
Nested Schema : at-x-anyOf[1]
Match One
Show Source
-
string
Minimum Length:
3Maximum Length:37Pattern:^([0-9]+[:][0-9]+)$Commit Sequence Number pattern(Legacy) for MySQL Database.Example:6488359:564781 -
string
Minimum Length:
77Maximum Length:77Pattern:^[0-9]{20}[:][0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}[:][0-9]{19}$CSN pattern(GTID format) for MySQL Database.Example:00000000000000000001:f77024f9-f4e3-11eb-a052-0021f6e03f10:0000000000000010654
Nested Schema : at-x-anyOf[4]
Match One
Show Source
-
integer
Minimum Value:
1Maximum Value:18446744073709552000Commit Sequence Number pattern (Legacy) for DB2400 Database.Example:78654321 -
string
Minimum Length:
32Maximum Length:32Pattern:^([a-fA-F0-9]{32})$Commit Sequence Number pattern (Receiver timestamp and sequence number) for DB2400 Database.Example:F0B4993FD22315E5F0B4993FD22315E5
Nested Schema : thresholds
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
Show Source
2Nested Schema : items
Type:
Show Source
object-
type(required):
Allowed Values:
[ "info", "critical" ] -
units(required):
units
-
value(required):
integer
Minimum Value:
0Maximum Value:65535
Nested Schema : credentials
Credentials for database
Default Value:
oracle.doceng.json.BetterJsonNull@10a0d93aMatch One
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 : credentials
Type:
objectCredentials for database
Show Source
-
$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 : specification
The name of a schema which can include wildcard characters
Match Any
Show Source
Nested Schema : credentials
Type:
objectCredentials for database
Show Source
-
$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 : specification
The name of a table or a group of tables which can include wildcard characters
Match Any
Show Source
Nested Schema : credentials
Type:
objectCredentials for database
Show Source
-
$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 : specification
The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters
Match Any
Show Source
Nested Schema : credentials
Type:
objectCredentials for database
Show Source
-
$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 : items
Type:
Show Source
object-
type(required):
Allowed Values:
[ "max" ] -
units(required):
units
-
value(required):
integer
Minimum Value:
1Maximum Value:500
Nested Schema : credentials
Type:
objectCredentials for database
Show Source
-
$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 : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Maximum number of hours
-
object items-x-oneOf[2]
Minimum number of days
-
object items-x-oneOf[3]
Maximum number of days
Nested Schema : items-x-oneOf[0]
Type:
objectMinimum number of hours
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "hours" ] -
value(required):
integer
Minimum Value:
1Maximum Value:1000Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
objectMaximum number of hours
Show Source
-
type(required):
Allowed Values:
[ "max" ] -
units(required):
Allowed Values:
[ "hours" ] -
value(required):
integer
Minimum Value:
1Maximum Value:1000Allowed value for hours value
Nested Schema : items-x-oneOf[2]
Type:
objectMinimum number of days
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "days" ] -
value(required):
integer
Minimum Value:
1Maximum Value:365Allowed value for days value
Nested Schema : items-x-oneOf[3]
Type:
objectMaximum number of days
Show Source
-
type(required):
Allowed Values:
[ "max" ] -
units(required):
Allowed Values:
[ "days" ] -
value(required):
integer
Minimum Value:
1Maximum Value:365Allowed value for days value
Nested Schema : trails
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
1024Trails to purge
Show Source
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Minimum number of days
-
object items-x-oneOf[2]
Minimum number of files
Nested Schema : items-x-oneOf[0]
Type:
objectMinimum number of hours
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "hours" ] -
value(required):
integer
Minimum Value:
1Maximum Value:1000Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
objectMinimum number of days
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "days" ] -
value(required):
integer
Minimum Value:
1Maximum Value:365Allowed value for days value
Nested Schema : items-x-oneOf[2]
Type:
objectMinimum number of files
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "files" ] -
value(required):
integer
Minimum Value:
0Maximum Value:100
Nested Schema : items
Type:
Show Source
object-
name(required):
name
-
path:
string
Minimum Length:
1Maximum Length:4096The path where trail data is stored
Nested Schema : name
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:2Pattern:^[A-Za-z*][A-Za-z0-9*]?$The name of the trail, wildcards allowed -
Allowed Values:
[ "*/*" ]All trails, including subdirectories
Nested Schema : archiveTarget
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:4096Filesystem directory where trail sequences are stored -
object archiveTarget-x-oneOf[1]
OCI Object Storage Bucket
-
object archiveTarget-x-oneOf[2]
S3-compatible object storage bucket
Nested Schema : sequences
Type:
objectOptional range of trail sequences to process. If not present, all sequences in a trail are processed.
Show Source
-
sequenceMax(required):
integer
Minimum Value:
0Maximum Value:999999999Default Value:0Last trail sequence to process -
sequenceMin(required):
integer
Minimum Value:
0Maximum Value:999999999Default Value:0First trail sequence to process
Nested Schema : trails
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
1024Trails to process
Show Source
Nested Schema : archiveTarget-x-oneOf[1]
Type:
objectOCI Object Storage Bucket
Show Source
-
authentication(required):
authentication
-
bucketName(required):
string
Minimum Length:
1Maximum Length:1024The name of the Object Storage bucket -
nameSpace(required):
string
Minimum Length:
1Maximum Length:256The OCI Object Storage namespace
Nested Schema : archiveTarget-x-oneOf[2]
Type:
objectS3-compatible object storage bucket
Show Source
-
authentication:
authentication
-
bucketName(required):
string
Minimum Length:
1Maximum Length:1024The name of the S3-compatible bucket -
region:
string
Minimum Length:
1Maximum Length:256The optional region for the S3-compatible bucket
Nested Schema : authentication
Match One
Show Source
-
object authentication-x-oneOf[0]
Authentication using a named profile from the default profile configuration file
-
object authentication-x-oneOf[1]
Authentication for OCI using an instance principal
-
object authentication-x-oneOf[2]
Authentication for OCI using an API signing key for a user
Nested Schema : authentication-x-oneOf[0]
Type:
objectAuthentication using a named profile from the default profile configuration file
Show Source
-
profile(required):
string
Minimum Length:
1Maximum Length:256Name of the profile to use
Nested Schema : authentication-x-oneOf[1]
Type:
objectAuthentication for OCI using an instance principal
Show Source
-
instancePrincipal(required):
Allowed Values:
[ true ]Indicates the instance principal should be used for authentication
Nested Schema : authentication-x-oneOf[2]
Type:
objectAuthentication for OCI using an API signing key for a user
Show Source
-
apiSigningKey(required):
string
Minimum Length:
1Maximum Length:10240Pattern:^-----BEGIN RSA PRIVATE KEY----- ([A-Za-z0-9+/= ])+ -----END RSA PRIVATE KEY-----Unencrypted API signing key -
apiSigningKeyFingerprint(required):
string
Minimum Length:
47Maximum Length:47Pattern:^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$Fingerprint of the API signing key -
tenancyId(required):
string
Minimum Length:
1Maximum Length:256Pattern:^ocid1[.]tenancy[.].*OCI tenancy OCID -
userId(required):
string
Minimum Length:
1Maximum Length:256Pattern:^ocid1[.]user[.].*OCI user OCID
Nested Schema : authentication
Match One
Show Source
-
object authentication-x-oneOf[0]
Authentication using a named profile from the default profile configuration file
-
object authentication-x-oneOf[1]
S3 Authentication using secrets
Nested Schema : authentication-x-oneOf[0]
Type:
objectAuthentication using a named profile from the default profile configuration file
Show Source
-
profile(required):
string
Minimum Length:
1Maximum Length:256Name of the profile to use
Nested Schema : authentication-x-oneOf[1]
Type:
objectS3 Authentication using secrets
Show Source
-
accessKeyId(required):
string
Minimum Length:
1Maximum Length:256S3 access key -
secretKey(required):
string
Minimum Length:
1Maximum Length:256S3 secret key
Nested Schema : items
Type:
Show Source
object-
name(required):
string
Minimum Length:
1Maximum Length:2Pattern:^[A-Za-z*][A-Za-z0-9*]?$The name of the trail, wildcards allowed -
path:
string
Minimum Length:
1Maximum Length:4096The path where trail data is stored
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Minimum number of days
Nested Schema : items-x-oneOf[0]
Type:
objectMinimum number of hours
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "hours" ] -
value(required):
integer
Minimum Value:
1Maximum Value:1000Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
objectMinimum number of days
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "days" ] -
value(required):
integer
Minimum Value:
1Maximum Value:365Allowed value for days value
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Minimum number of days
Nested Schema : items-x-oneOf[0]
Type:
objectMinimum number of hours
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "hours" ] -
value(required):
integer
Minimum Value:
1Maximum Value:1000Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
objectMinimum number of days
Show Source
-
type(required):
Allowed Values:
[ "min" ] -
units(required):
Allowed Values:
[ "days" ] -
value(required):
integer
Minimum Value:
1Maximum Value:365Allowed value for days value
Nested Schema : credentials
Type:
objectCredentials for database
Show Source
-
$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 : items
Match One
Show Source
-
object items-x-oneOf[0]
Maximum number of hours
-
object items-x-oneOf[1]
Maximum number of days
Nested Schema : items-x-oneOf[0]
Type:
objectMaximum number of hours
Show Source
-
type(required):
Allowed Values:
[ "max" ] -
units(required):
Allowed Values:
[ "hours" ] -
value(required):
integer
Minimum Value:
1Maximum Value:1000Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
objectMaximum number of days
Show Source
-
type(required):
Allowed Values:
[ "max" ] -
units(required):
Allowed Values:
[ "days" ] -
value(required):
integer
Minimum Value:
1Maximum Value:365Allowed value for days value
Nested Schema : credentials
Type:
objectCredentials for database
Show Source
-
$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 : sequence
The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.
Match Any
Show Source
-
string
Minimum Length:
1Maximum Length:130Pattern:^([^."]{1,128}|["].{1,128}["])$ -
string
Minimum Length:
3Maximum Length:261Pattern:^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$ -
string
Minimum Length:
5Maximum Length:392Pattern:^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Example Request (application/json)
{
"name":"report",
"reportType":"lag",
"thresholds":[
{
"type":"info",
"units":"seconds",
"value":"0"
},
{
"type":"critical",
"units":"seconds",
"value":"5"
}
]
}Response
Supported Media Types
- application/json
200 Response
Command successfully executed.
Root Schema : Oracle GoldenGate Task Manager Command Result
Type:
objectTitle:
Show Source
Oracle GoldenGate Task Manager Command Result-
$schema:
Allowed Values:
[ "ogg:commandResult" ] -
containers:
array containers
Minimum Number of Items:
0Maximum Number of Items:32767 -
items:
array items
Minimum Number of Items:
0Maximum Number of Items:1024 -
messages:
array messages
Minimum Number of Items:
0Maximum Number of Items:1024 -
schemas:
array schemas
Minimum Number of Items:
0Maximum Number of Items:32767 -
tables:
array tables
Minimum Number of Items:
0Maximum Number of Items:32767 -
versions:
object versions
Nested Schema : containers
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767Nested Schema : items
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
1024Nested Schema : messages
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
1024Nested Schema : schemas
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767Nested Schema : tables
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
Show Source
32767Nested Schema : versions
Type:
Show Source
object-
$schema:
Allowed Values:
[ "ogg:versions" ] -
build:
object build
Oracle GoldenGate build information
-
database:
array database
Minimum Number of Items:
1Maximum Number of Items:100Database version information -
operatingSystem:
operatingSystem
Operating System version information
Nested Schema : items
Match One
Show Source
-
string
Minimum Length:
1Maximum Length:130Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items-x-oneOf[0]
Type:
Show Source
object-
processName(required):
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$ -
processType(required):
Default Value:
ERAllowed Values:[ "extract", "replicat", "ER" ] -
result:
result
-
severity(required):
Allowed Values:
[ "info", "critical" ]
Nested Schema : items-x-oneOf[1]
Type:
Show Source
object-
processId(required):
integer
Minimum Value:
1Maximum Value:4294967295Process identifier for task command -
processName:
string
Minimum Length:
1Maximum Length:8Pattern:^[A-Z_$][A-Z0-9_$]*$
Nested Schema : result
Match One
Show Source
-
Allowed Values:
[ "up", "down" ]Report on Processes -
object result-x-oneOf[1]
Report on Process Lag
Nested Schema : result-x-oneOf[1]
Type:
objectReport on Process Lag
Show Source
-
lag(required):
string
Minimum Length:
11Maximum Length:13Process lag in H:MM:SS.mmm format -
lagSeconds(required):
number
Process lag in seconds
-
lastCheckpoint(required):
string
Minimum Length:
11Maximum Length:13Time since last checkpoint in H:MM:SS.mmm format -
lastCheckpointSeconds(required):
number
Time since last checkpoint in seconds
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.
Nested Schema : build
Type:
objectOracle GoldenGate build information
Show Source
-
buildDate(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])$Date and time release was built -
label(required):
string
Minimum Length:
1Maximum Length:64Oracle GoldenGate internal label -
optimized(required):
boolean
Optimized build
-
release(required):
string
Minimum Length:
10Maximum Length:21Pattern:^[1-9][0-9]([.][0-9]{1,3}){3}[.]([0-9]{1,3}|[0-9]{6})$Oracle GoldenGate release number -
targetArch(required):
string
Minimum Length:
1Maximum Length:64Target architecture -
targetDBMS(required):
string
Minimum Length:
1Maximum Length:64Target database -
targetDBMSVersion(required):
string
Minimum Length:
1Maximum Length:64Target database version -
targetOS(required):
string
Minimum Length:
1Maximum Length:64Target operating system
Nested Schema : database
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
100Database version information
Show Source
-
Array of:
string
Minimum Length:
1Maximum Length:4095
Nested Schema : operatingSystem-x-oneOf[0]
Type:
Show Source
object-
buildNumber:
integer
Minimum Value:
0Maximum Value:4294967295 -
name(required):
string
Minimum Length:
1Maximum Length:1024 -
servicePack:
string
Minimum Length:
1Maximum Length:1024 -
versionMajor:
integer
Minimum Value:
0Maximum Value:99Major version -
versionMinor:
integer
Minimum Value:
0Maximum Value:99Minor version
Nested Schema : operatingSystem-x-oneOf[1]
Type:
Show Source
object-
machine(required):
string
Minimum Length:
1Maximum Length:1024 -
name(required):
string
Minimum Length:
1Maximum Length:1024 -
node(required):
string
Minimum Length:
1Maximum Length:1024 -
release(required):
string
Minimum Length:
1Maximum Length:1024 -
version(required):
string
Minimum Length:
1Maximum Length:1024
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9012/services/v2/commands/execute",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/commands/execute",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
{
"$schema":"ogg:message",
"code":"OGG-02950",
"issued":"2024-04-03T22:36:16Z",
"severity":"INFO",
"title":"Lag for Extract group EXTN is 0:00:03.965 (checkpoint updated 0:00:52.638 ago).",
"type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
},
{
"$schema":"ogg:message",
"code":"OGG-02953",
"issued":"2024-04-03T22:36:16Z",
"severity":"INFO",
"title":"Lag for Replicat group REPS is 0:00:00.000 (checkpoint updated 0:00:00.290 ago).",
"type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
}
],
"response":{
"$schema":"ogg:commandResult",
"items":[
{
"processName":"EXTN",
"processType":"extract",
"result":{
"lag":"0:00:03.965",
"lagSeconds":"3.965",
"lastCheckpoint":"0:00:52.638",
"lastCheckpointSeconds":"52.638"
},
"severity":"info"
},
{
"processName":"REPS",
"processType":"replicat",
"result":{
"lag":"0:00:00.000",
"lagSeconds":"0",
"lastCheckpoint":"0:00:00.290",
"lastCheckpointSeconds":"0.29"
},
"severity":"info"
}
]
}
}