1. Oracle GoldenGate
  2. Tasks
  3. Administrative Server
  4. Commands

Execute Command

post

/services/{version}/commands/execute

Execute a command

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Oracle GoldenGate Task Manager Command
Title: Oracle GoldenGate Task Manager Command
Match One
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[0]
Type: object
Start an Extract or Replicat
Show Source
  • Allowed Values: [ "ogg:command" ]
  • 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
    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.
  • Default Value: true
    Causes 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.
  • Allowed Values: [ "start" ]
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[*A-Z_$][*A-Z0-9_$]*$
  • Default Value: ER
    Allowed Values: [ "extract", "replicat", "ER" ]
  • Default Value: false
    Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded.
  • threads
    Minimum Number of Items: 1
    Maximum Number of Items: 500
    Valid 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
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[1]
Type: object
Stop an Extract or Replicat
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[2]
Type: object
Kill an Extract or Replicat
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[3]
Type: object
Execute an Extract or Replicat
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[4]
Type: object
Synchronize a Replicat
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[5]
Type: object
Execute the Monitor Agent
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[6]
Type: object
Report on Processes
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[7]
Type: object
Report on Process Lag
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[8]
Type: object
Report Operating System and database version information
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[9]
Type: object
Lists the schemas in the database with names that match the input specification
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[10]
Type: object
Lists the tables in the database with names that match the input specification
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[11]
Type: object
Lists the checkpoint tables in the database with names that match the input specification
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[12]
Type: object
Lists the containers in the database with names that match the input specification
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[13]
Type: object
Purge checkpoint history for ER processes
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[14]
Type: object
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[15]
Type: object
Purge trail files no longer needed
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[16]
Type: object
Purge Extract or Replicat tasks
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[17]
Type: object
Purge files no longer needed
Show Source
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[18]
Type: object
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.
Show Source
  • Allowed Values: [ "ogg:command" ]
  • credentials
    Credentials for database
  • Allowed Values: [ "flushSequence" ]
  • 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.
  • Default Value: false
    Whether 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 One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
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 One
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
Nested Schema : threads
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 500
Valid 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
Nested Schema : Oracle GoldenGate Task Manager Command-x-oneOf[0]-allOf[5]
Match Any
Show Source
Nested Schema : thresholds
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : units
Match One
Show Source
  • Allowed Values: [ "seconds" ]
  • Allowed Values: [ "minutes" ]
  • Allowed Values: [ "hours" ]
Nested Schema : credentials
Credentials for database
Default Value: oracle.doceng.json.BetterJsonNull@6cd27d52
Match One
Show Source
Nested Schema : credentials-x-oneOf[0]
Type: object
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : specification
The name of a schema which can include wildcard characters
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[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
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[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
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : units
Match One
Show Source
  • Allowed Values: [ "checkpoints" ]
Nested Schema : credentials
Type: object
Credentials for database
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • Minimum Value: 1
    Maximum Value: 1000
    Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type: object
Maximum number of hours
Show Source
  • Allowed Values: [ "max" ]
  • Allowed Values: [ "hours" ]
  • Minimum Value: 1
    Maximum Value: 1000
    Allowed value for hours value
Nested Schema : items-x-oneOf[2]
Type: object
Minimum number of days
Show Source
Nested Schema : items-x-oneOf[3]
Type: object
Maximum number of days
Show Source
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : trails
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Trails to purge
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • Minimum Value: 1
    Maximum Value: 1000
    Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type: object
Minimum number of days
Show Source
Nested Schema : items-x-oneOf[2]
Type: object
Minimum number of files
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^[A-Za-z][A-Za-z0-9]?$
    The name of the trail
  • Minimum Length: 1
    Maximum Length: 255
    The path where trail data is stored
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • Minimum Value: 1
    Maximum Value: 1000
    Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type: object
Minimum number of days
Show Source
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • Minimum Value: 1
    Maximum Value: 1000
    Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type: object
Minimum number of days
Show Source
Nested Schema : credentials
Type: object
Credentials for database
Show Source
  • Allowed Values: [ "ogg:credentialsRef" ]
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
  • Minimum Length: 1
    Maximum Length: 30
    Default Value: OracleGoldenGate
    Pattern: ^[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
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{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

200 Response

Command successfully executed.

Body ()
Root Schema : Oracle GoldenGate Task Manager Command Result
Type: object
Title: Oracle GoldenGate Task Manager Command Result
Show Source
Nested Schema : containers
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : schemas
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : tables
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : versions
Type: object
Show Source
Nested Schema : items
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
Nested Schema : result
Match One
Show Source
Nested Schema : result-x-oneOf[1]
Type: object
Report on Process Lag
Show Source
Nested Schema : processName
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$
  • Allowed Values: [ "Monitor Agent" ]
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • 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.
  • 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.
Nested Schema : items
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : build
Type: object
Oracle GoldenGate build information
Show Source
  • 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])$
    Date and time release was built
  • Minimum Length: 1
    Maximum Length: 64
    Oracle GoldenGate internal label
  • Optimized build
  • Minimum Length: 9
    Maximum Length: 19
    Pattern: ^([1-9][0-9]{0,2})([.][0-9]{1,3}){4}$
    Oracle GoldenGate release number
  • Minimum Length: 1
    Maximum Length: 64
    Target architecture
  • Minimum Length: 1
    Maximum Length: 64
    Target database
  • Minimum Length: 1
    Maximum Length: 64
    Target database version
  • Minimum Length: 1
    Maximum Length: 64
    Target operating system
Nested Schema : database
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Database version information
Show Source
Nested Schema : operatingSystem
Operating System version information
Match One
Show Source
Nested Schema : operatingSystem-x-oneOf[0]
Type: object
Show Source
Nested Schema : operatingSystem-x-oneOf[1]
Type: object
Show Source
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/commands/execute",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/commands/execute",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-00948",
            "issued":"2017-12-14T12:44:44Z",
            "severity":"INFO",
            "title":"Lag for EXTRACT EXT2 is 0:00:03.162 (checkpoint updated 0:00:53.572 ago)",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-00948"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-00948",
            "issued":"2017-12-14T12:44:44Z",
            "severity":"INFO",
            "title":"Lag for REPLICAT REP2 is 0:00:00.000 (checkpoint updated 0:00:02.223 ago)",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-00948"
        }
    ],
    "response":{
        "$schema":"ogg:commandResult",
        "items":[
            {
                "processName":"REP2",
                "processType":"replicat",
                "result":{
                    "lag":"0:00:00.000",
                    "lagSeconds":0,
                    "lastCheckpoint":"0:00:02.223",
                    "lastCheckpointSeconds":2.223
                },
                "severity":"info"
            },
            {
                "processName":"EXT2",
                "processType":"extract",
                "result":{
                    "lag":"0:00:03.162",
                    "lagSeconds":3.162,
                    "lastCheckpoint":"0:00:53.572",
                    "lastCheckpointSeconds":53.572
                },
                "severity":"info"
            }
        ]
    }
}