1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Administration Service
  4. Replicats

Create Replicat

post

/services/{version}/replicats/{replicat}

Required Role: Administrator

Create a new replicat process.

Request

Supported Media Types
Path Parameters
  • 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.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Oracle GoldenGate Replicat
Type: object
Title: Oracle GoldenGate Replicat
Show Source
Nested Schema : begin
Starting point for data processing
Default Value: now
Match One
Show Source
  • Allowed Values: [ "now" ]
  • 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])$
  • 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
  • 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: 32767
Show Source
Nested Schema : credentials
Credentials for target database
Default Value: oracle.doceng.json.BetterJsonNull@7baf6acf
Match One
Show Source
Nested Schema : encryptionProfile
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 64
    Pattern: ^[A-Za-z0-9][A-Za-z0-9_:-]*$
    Name of 'ogg:encryptionProfile' configuration value
Nested Schema : managedProcessSettings
Control how the ER process is managed by the Administration Server
Match One
Show Source
Nested Schema : mode
Mode of replication
Match One
Show Source
Nested Schema : source
Source of data to process
Match One
Show Source
Nested Schema : begin-x-oneOf[2]
Type: object
Show Source
  • Allowed Values: [ "type:position/atTrailRBA" ]
  • Minimum Value: 0
    Maximum Value: 2147483647
    Default Value: 0
    Offset in trail sequence file
  • 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 : table
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-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 : managedProcessSettings-x-oneOf[0]
Type: object
Custom settings
Show Source
Nested Schema : autoRestart
Type: object
Control how the ER process is restarted by the Administration Server if it terminates
Default Value: { "enabled":false, "onSuccess":false, "delay":"0", "retries":"9", "window":"60", "disableOnFailure":true }
Show Source
  • Allowed Values: [ "ogg:taskRestart" ]
  • 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.
  • Default Value: true
    If true, the task is disabled when it fails all execution attempts in an execution window.
  • Default Value: false
    If set, the task can be restarted if it terminates.
  • Minimum Value: 0
    Maximum Value: 3600
    The number of times the task failed in the current window.
  • Default Value: false
    If false, the task is only restarted if it fails.
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 9
    The maximum number of times the task should be restarted before aborting retry efforts.
  • 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
  • Minimum Value: 0
    Maximum Value: 3600
    Default Value: 0
    Time to wait in seconds before starting process
  • 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
Nested Schema : mode-x-oneOf[1]
Type: object
(Oracle Only) Creates a standard, integrated Replicat
Show Source
Nested Schema : mode-x-oneOf[2]
Type: object
(Oracle Only) Coordinated Replicat
Show Source
Nested Schema : parallel
Match One
Show Source
  • Default Value: false
    Apply multiple operations in parallel
  • Allowed Values: [ "bidirectional", "unidirectional" ]
    (SQL Server Only) Apply multiple operations in bidirectional parallel mode
Nested Schema : source-x-oneOf[1]
Type: object
Show Source
Nested Schema : source-x-oneOf[2]
Type: object
Show Source
  • Allowed Values: [ "ogg:trailRef" ]
  • Minimum Length: 2
    Maximum Length: 512
    Pattern: ^[a-zA-Z0-9_#$/-]*$
    The name of the trail
  • Minimum Length: 1
    Maximum Length: 4096
    The path where the trail data is stored
Example Request (application/json)
{
    "mode":{
        "type":"integrated"
    },
    "credentials":{
        "alias":"ggsouth"
    },
    "config":[
        "Replicat    reps",
        "UseridAlias ggsouth",
        "Map         hr.*,",
        "  Target    hr.*;"
    ],
    "source":{
        "name":"ea",
        "path":"ggnorth/"
    },
    "checkpoint":{
        "table":"ggadmin.ggs_checkpoint"
    }
}
Back to Top

Response

Supported Media Types

201 Response

The replicat process was created successfully.

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
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: 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.
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-08100",
            "issued":"2024-04-03T22:35:29Z",
            "severity":"INFO",
            "title":"Integrated Replicat added.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-10183",
            "issued":"2024-04-03T22:35:29Z",
            "severity":"INFO",
            "title":"Parameter file REPS.prm passed validity check.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        }
    ]
}
Back to Top